# Audit GitHub REST rate limit docs

**Use case:** 

Run a ready-made audit of GitHub REST API rate-limit documentation for limits, headers, reset timing, and retry guidance.

## Input

```json
{
  "startUrls": [
    {
      "url": "https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api"
    }
  ],
  "maxPagesPerSite": 3,
  "timeoutSecs": 20,
  "sameHostOnly": true
}
```

## Output

```json
{
  "domain": {
    "label": "Domain",
    "format": "text"
  },
  "auditScore": {
    "label": "Score",
    "format": "number"
  },
  "grade": {
    "label": "Grade",
    "format": "text"
  },
  "riskLevel": {
    "label": "Documentation risk",
    "format": "text"
  },
  "rateLimitDocsFound": {
    "label": "Rate-limit docs found",
    "format": "boolean"
  },
  "limitsQuantified": {
    "label": "Limits quantified",
    "format": "boolean"
  },
  "rateLimitHeadersDocumented": {
    "label": "Rate-limit headers documented",
    "format": "boolean"
  },
  "http429Documented": {
    "label": "HTTP 429 documented",
    "format": "boolean"
  },
  "retryAfterDocumented": {
    "label": "Retry-After documented",
    "format": "boolean"
  },
  "backoffGuidance": {
    "label": "Backoff guidance",
    "format": "boolean"
  },
  "quotaScopesDocumented": {
    "label": "Quota scope documented",
    "format": "boolean"
  },
  "resetWindowDocumented": {
    "label": "Reset window documented",
    "format": "boolean"
  },
  "codeExamplesFound": {
    "label": "Examples found",
    "format": "boolean"
  },
  "bestPageUrl": {
    "label": "Best evidence URL",
    "format": "link"
  },
  "pagesAnalyzed": {
    "label": "Pages analyzed",
    "format": "number"
  },
  "urlsFetched": {
    "label": "URLs fetched",
    "format": "number"
  },
  "error": {
    "label": "Error",
    "format": "text"
  },
  "warnings": {
    "label": "Warnings",
    "format": "array"
  },
  "recommendations": {
    "label": "Recommendations",
    "format": "array"
  }
}
```

## About this Actor

This example demonstrates how to use [Rate Limit Docs Audit](https://apify.com/defenestrator/rate-limit-docs-audit) with a specific input configuration. Visit the [Actor detail page](https://apify.com/defenestrator/rate-limit-docs-audit) to learn more, explore other use cases, and run it yourself.