REST API endpoints for API Insights
Use the REST API to view statistics for API usage in an organization.
Get route stats by actor
Get API request count statistics for an actor broken down by route within a specified time frame.
Jetons dâaccĂšs affinĂ©s pour « Get route stats by actor »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get route stats by actor »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
actor_type string ObligatoireThe type of the actor Peut ĂȘtre: |
actor_id integer ObligatoireThe ID of the actor |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
direction string The direction to sort the results by. Default: Peut ĂȘtre: |
sort array The property to sort the results by. |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get route stats by actor »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get route stats by actor »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/route-stats/ACTOR_TYPE/ACTOR_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
[
{
"http_method": "GET",
"api_route": "/repositories/:repository_id",
"total_request_count": 544665,
"rate_limited_request_count": 13,
"last_request_timestamp": "2024-09-18T15:43:03Z",
"last_rate_limited_timestamp": "2024-09-18T06:30:09Z"
}
]
Get subject stats
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
Jetons dâaccĂšs affinĂ©s pour « Get subject stats »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get subject stats »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
direction string The direction to sort the results by. Default: Peut ĂȘtre: |
sort array The property to sort the results by. |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get subject stats »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get subject stats »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/subject-stats?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
[
{
"subject_type": "installation",
"subject_id": 954453,
"subject_name": "GitHub Actions",
"integration_id": 124345,
"total_request_count": 544665,
"rate_limited_request_count": 13,
"last_request_timestamp": "2024-09-18T15:43:03Z",
"last_rate_limited_timestamp": "2024-09-18T06:30:09Z"
}
]
Get summary stats
Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
Jetons dâaccĂšs affinĂ©s pour « Get summary stats »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get summary stats »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get summary stats »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get summary stats »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/summary-stats?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
{
"total_request_count": 34225,
"rate_limited_request_count": 23
}
Get summary stats by user
Get overall statistics of API requests within the organization for a user.
Jetons dâaccĂšs affinĂ©s pour « Get summary stats by user »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get summary stats by user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
user_id string ObligatoireThe ID of the user to query for stats |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get summary stats by user »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get summary stats by user »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/summary-stats/users/USER_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
{
"total_request_count": 34225,
"rate_limited_request_count": 23
}
Get summary stats by actor
Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.
Jetons dâaccĂšs affinĂ©s pour « Get summary stats by actor »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get summary stats by actor »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
actor_type string ObligatoireThe type of the actor Peut ĂȘtre: |
actor_id integer ObligatoireThe ID of the actor |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get summary stats by actor »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get summary stats by actor »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/summary-stats/ACTOR_TYPE/ACTOR_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
{
"total_request_count": 34225,
"rate_limited_request_count": 23
}
Get time stats
Get the number of API requests and rate-limited requests made within an organization over a specified time period.
Jetons dâaccĂšs affinĂ©s pour « Get time stats »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get time stats »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
timestamp_increment string ObligatoireThe increment of time used to breakdown the query results (5m, 10m, 1h, etc.) |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get time stats »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get time stats »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/time-stats?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP×tamp_increment=TIMESTAMP_INCREMENT"
Response
Status: 200
[
{
"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
}
]
Get time stats by user
Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
Jetons dâaccĂšs affinĂ©s pour « Get time stats by user »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get time stats by user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
user_id string ObligatoireThe ID of the user to query for stats |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
timestamp_increment string ObligatoireThe increment of time used to breakdown the query results (5m, 10m, 1h, etc.) |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get time stats by user »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get time stats by user »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/time-stats/users/USER_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP×tamp_increment=TIMESTAMP_INCREMENT"
Response
Status: 200
[
{
"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
}
]
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.
Jetons dâaccĂšs affinĂ©s pour « Get time stats by actor »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get time stats by actor »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
actor_type string ObligatoireThe type of the actor Peut ĂȘtre: |
actor_id integer ObligatoireThe ID of the actor |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
timestamp_increment string ObligatoireThe increment of time used to breakdown the query results (5m, 10m, 1h, etc.) |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get time stats by actor »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get time stats by actor »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/time-stats/ACTOR_TYPE/ACTOR_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP×tamp_increment=TIMESTAMP_INCREMENT"
Response
Status: 200
[
{
"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
}
]
Get user stats
Get API usage statistics within an organization for a user broken down by the type of access.
Jetons dâaccĂšs affinĂ©s pour « Get user stats »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons dâaccĂšs utilisateur dâapplication GitHub
- Jetons dâaccĂšs dâinstallation dâapplication GitHub
- Jetons dâaccĂšs personnel affinĂ©
Le jeton prĂ©cis doit avoir lâensemble dâautorisations suivant:
- "API Insights" organization permissions (read)
ParamÚtres pour « Get user stats »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
org string ObligatoireThe organization name. The name is not case sensitive. |
user_id string ObligatoireThe ID of the user to query for stats |
Nom, Type, Description |
---|
min_timestamp string ObligatoireThe minimum timestamp to query for stats |
max_timestamp string ObligatoireThe maximum timestamp to query for stats |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
direction string The direction to sort the results by. Default: Peut ĂȘtre: |
sort array The property to sort the results by. |
Codes dâĂ©tat de la rĂ©ponse HTTP pour « Get user stats »
Code dâĂ©tat | Description |
---|---|
200 | OK |
Exemples de code pour « Get user stats »
If you access GitHub at GHE.com, replace api.github.com
with your enterprise's dedicated subdomain at api.SUBDOMAIN.ghe.com
.
Exemple de requĂȘte
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
"https://api.github.com/orgs/ORG/insights/api/user-stats/USER_ID?min_timestamp=MIN_TIMESTAMP&max_timestamp=MAX_TIMESTAMP"
Response
Status: 200
[
{
"actor_type": "oauth_app",
"actor_id": 954453,
"actor_name": "GitHub Actions",
"oauth_application_id": 1245,
"total_request_count": 544665,
"rate_limited_request_count": 13,
"last_request_timestamp": "2024-09-18T15:43:03Z",
"last_rate_limited_timestamp": "2024-09-18T06:30:09Z"
}
]