v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB

orgs

Get route stats by actor

Get API request count statistics for an actor broken down by route within a specified time frame.

Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.

get/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}

Path parameters

orgstring required

The organization name. The name is not case sensitive.

actor_type'installation' | 'classic_pat' | 'fine_grained_pat' | 'oauth_app' | 'github_app_user_to_server' required

The type of the actor

actor_idinteger required

The ID of the actor

Query parameters

min_timestampstring required

The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

max_timestampstring

The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

direction'asc' | 'desc'

The direction to sort the results by.

sortstring[]

The property to sort the results by.

api_route_substringstring

Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.

Response

http_methodstring

The HTTP method

api_routestring

The API path's route template

total_request_countinteger

The total number of requests within the queried time period

rate_limited_request_countinteger

The total number of requests that were rate limited within the queried time period

last_rate_limited_timestampstring nullable

last_request_timestampstring