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

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.

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.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters

orgstringrequired

The organization name. The name is not case sensitive.

actor_typestringrequired

The type of the actor

Allowed:installationclassic_patfine_grained_patoauth_appgithub_app_user_to_server

actor_idintegerrequired

The ID of the actor

min_timestampstringrequired

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`.

max_timestampstringoptional

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`.

1 status code

200Response

total_request_countintegeroptional

The total number of requests within the queried time period

rate_limited_request_countintegeroptional

The total number of requests that were rate limited within the queried time period

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.summaryStats.get({
  org: "acme-inc",
  actorType: "example",
  actorId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  minTimestamp: "2024-01-15T09:30:00Z",
  maxTimestamp: "2024-01-15T09:30:00Z",
});

{
  "total_request_count": 34225,
  "rate_limited_request_count": 23
}

Request

Response