GET /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}

Get API request count statistics for an actor broken down by route within a specified time frame.

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
page Integer No

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Default value: 1

api_route_substring String No

Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.

direction String No

The direction to sort the results by.

Possible values:

  • "desc"
  • "asc"

Default value: "desc"

per_page Integer No

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Default value: 30

sort[] Array No

The property to sort the results by.

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.