Get summary stats by actor

GET

/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}

Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

actor_type

required

string

Allowed values: installation classic_pat fine_grained_pat oauth_app github_app_user_to_server

The type of the actor

actor_id

required

integer

The ID of the actor

Query Parameters

min_timestamp

required

string

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

max_timestamp

string

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.

Responses

200

Response

Media type application/json

Summary Stats

API Insights usage summary stats for an organization

object

total_request_count

The total number of requests within the queried time period

integer format: int64

rate_limited_request_count

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

integer format: int64

Examples

Example default

{
  "total_request_count": 34225,
  "rate_limited_request_count": 23
}