Search + K

Command Palette

Search for a command to run...

Sign In

Get time stats by actor

GET /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}
Copy endpoint
https://api.github.com

Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.

Parameters

path Path Parameters

Name Type
org required

The organization name. The name is not case sensitive.

string
actor_type required

The type of the actor

"installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"
actor_id required

The ID of the actor

number

query Query Parameters

Name Type
min_timestamp required

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

string
max_timestamp

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.

string
timestamp_increment required

The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)

string

Responses

200 application/json

Response

type ApiInsightsTimeStats = { timestamp?: string;total_request_count?: number;rate_limited_request_count?: number; }[]