| Endpoint essentials | |
|---|---|
| API key access | api/v1/usage_stats/api_usage_stats or Master API key |
| OAuth scopes | api_usage_stats_read |
| Credit usage | 0 creditsLearn more about API pricing and credits. |
Use the view API usage stats endpoint to view your team's usage of Apollo API and your rate limit for API endpoints.
Each endpoint has a rate limit per minute, hour, and day. Your Apollo plan impacts API endpoint rate limits.
By default, the response covers a fixed list of endpoints, not every endpoint you can call. To check other endpoints, use the endpoints[] parameter.
Check specific endpoints
Pass each endpoint in the endpoints[] parameter as the path shown in the API key access row of its page, without a leading slash. For example, the path for view an account is api/v1/accounts/show. You can also send the paths as a JSON array in the request body, such as {"endpoints": ["api/v1/accounts/show"]}.
The response then includes only the endpoints you request. Each endpoint's key in the response is a string in the form ["api/v1/accounts", "show"].
You can request up to 74 endpoints at a time. Each one must be an endpoint you can add to an API key. Otherwise, Apollo returns a 422 response with one of these error_details.code values:
| Code | Cause |
|---|---|
USAGE.VALIDATION.UNKNOWN_ENDPOINT | A path isn't an endpoint you can add to an API key, or it starts with /. error_details.context.endpoints.value lists the rejected paths. |
USAGE.VALIDATION.TOO_MANY_ENDPOINTS | The request includes more than 74 endpoints. |