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.

Servers

Path parameters

Name Type Required Description
actor_id Integer Yes

The ID of the actor

org String Yes

The organization name. The name is not case sensitive.

actor_type String Yes

The type of the actor

Possible values:

  • "installation"
  • "classic_pat"
  • "oauth_app"
  • "fine_grained_pat"
  • "github_app_user_to_server"

Query parameters

Name Type Required Description
timestamp_increment String Yes

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

max_timestamp String No

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.

min_timestamp String Yes

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.