GitHub: Get subject stats

← Orgs operations · Get started

Operation github.api_insights_get_subject_stats

Provider route: GET /orgs/{org}/insights/api/subject-stats. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["orgs"]["apiInsightsGetSubjectStats"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.orgs.apiInsightsGetSubjectStats(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.orgs.api_insights_get_subject_stats(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.org	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.min_timestamp	string	Required within parent
query.max_timestamp	string	Optional
query.page	integer	Optional	Default: 1
query.per_page	integer	Optional	Default: 30
query.direction	string	Optional	Default: desc One of: asc, desc
query.sort	array	Optional
query.sort[]	string	Each item	Default: total_request_count One of: last_rate_limited_timestamp, last_request_timestamp, rate_limited_request_count, subject_name, total_request_count
query.subject_name_substring	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get subject stats — response body

Referenced models: Get subject stats — response body

Schemas

Get subject stats — response body

Field	Type	Presence	Description and constraints
$	array	Root	API Insights usage subject stats for an organization
$[]	object	Each item
$[].last_rate_limited_timestamp	JSON	Optional
$[].last_rate_limited_timestamp (anyOf 1)	string	Alternative
$[].last_rate_limited_timestamp (anyOf 2)	null	Alternative
$[].last_request_timestamp	string	Optional
$[].rate_limited_request_count	JSON	Optional
$[].rate_limited_request_count (anyOf 1)	integer	Alternative
$[].rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].subject_id	JSON	Optional
$[].subject_id (anyOf 1)	integer	Alternative	Format: int64
$[].subject_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].subject_name	string	Optional
$[].subject_type	string	Optional
$[].total_request_count	JSON	Optional
$[].total_request_count (anyOf 1)	integer	Alternative
$[].total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.api_insights_get_subject_stats. Catalog operation: api-insights/get-subject-stats. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source