Get time stats by actor

GET

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

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

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.

timestamp_increment

required

string

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

Responses

200

Response

Media type application/json

Time Stats

API Insights usage time stats for an organization

Array<object>

object

timestamp

string

total_request_count

integer format: int64

rate_limited_request_count

integer format: int64

Examples

Example default

[
  {
    "timestamp": "2024-09-11T15:00:00Z",
    "total_request_count": 34225,
    "rate_limited_request_count": 0
  },
  {
    "timestamp": "2024-09-11T15:05:00Z",
    "total_request_count": 10587,
    "rate_limited_request_count": 18
  },
  {
    "timestamp": "2024-09-11T15:10:00Z",
    "total_request_count": 43587,
    "rate_limited_request_count": 14
  },
  {
    "timestamp": "2024-09-11T15:15:00Z",
    "total_request_count": 19463,
    "rate_limited_request_count": 4
  },
  {
    "timestamp": "2024-09-11T15:20:00Z",
    "total_request_count": 60542,
    "rate_limited_request_count": 3
  },
  {
    "timestamp": "2024-09-11T15:25:00Z",
    "total_request_count": 55872,
    "rate_limited_request_count": 23
  }
]