api_insights_user_stats

Creates, updates, deletes, gets or lists an api_insights_user_stats resource.

Overview

Name	api_insights_user_stats
Type	Resource
Id	github.orgs.api_insights_user_stats

Fields

The following fields are returned by SELECT queries:

get_user_stats

Response

Name	Datatype	Description
actor_id	integer (int64)
integration_id	integer (int64)
oauth_application_id	integer (int64)
actor_name	string
actor_type	string
last_rate_limited_timestamp	string
last_request_timestamp	string
rate_limited_request_count	integer
total_request_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_stats	select	org, user_id, min_timestamp	max_timestamp, page, per_page, direction, sort, actor_name_substring	Get API usage statistics within an organization for a user broken down by the type of access. Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
min_timestamp	string	The minimum timestamp to query for stats. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
org	string	The organization name. The name is not case sensitive.
user_id	string	The ID of the user to query for stats
actor_name_substring	string	Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.
direction	string	The direction to sort the results by.
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.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
sort	array	The property to sort the results by.

SELECT examples

get_user_stats

Get API usage statistics within an organization for a user broken down by the type of access.

Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.

SELECT
actor_id,
integration_id,
oauth_application_id,
actor_name,
actor_type,
last_rate_limited_timestamp,
last_request_timestamp,
rate_limited_request_count,
total_request_count
FROM github.orgs.api_insights_user_stats
WHERE org = '{{ org }}' -- required
AND user_id = '{{ user_id }}' -- required
AND min_timestamp = '{{ min_timestamp }}' -- required
AND max_timestamp = '{{ max_timestamp }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND direction = '{{ direction }}'
AND sort = '{{ sort }}'
AND actor_name_substring = '{{ actor_name_substring }}'
;