provider orgs GET /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}
@utdk/github /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}
Get time stats by actor
Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
org path required
The organization name. The name is not case sensitive.
string
actor_type path required
The type of the actor
enum: installation, classic_pat, fine_grained_pat, oauth_app…
actor_id path required
The ID of the actor
integer
min_timestamp query required
The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
string
max_timestamp query
The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
string
timestamp_increment query required
The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

apiInsights.getTimeStatsByActor
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.

Parameters

required

The organization name. The name is not case sensitive.

required

The type of the actor

required

The ID of the actor

required

The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

required

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.apiInsights.getTimeStatsByActor()