v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
billing

Get a usage report export

Gets the status and details of a usage report export by ID. The authenticated user must be an enterprise admin or billing manager.

get/enterprises/{enterprise}/settings/billing/reports/{report_id}

Path parameters

enterprisestring required

The slug version of the enterprise name.

report_idstring uuid required

The unique identifier (UUID) for the usage report export.

Response

Usage report export details

idstring uuid required

Unique identifier for the usage report export

report_type'detailed' | 'summarized' | 'premium_request' | 'ai_credit' required

The type of usage report

start_datestring date required

The start date for the report

end_datestring date required

The end date for the report

status'processing' | 'completed' | 'failed' required

The current status of the report export

download_urlsstring[]

URLs to download the completed report. Only present when the report status is completed.

created_atstring date-time

When the report export was created

actorstring

The login of the user who requested the export

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "report_type": "detailed",
  "start_date": "2024-01-01",
  "end_date": "2024-01-31",
  "status": "completed",
  "download_urls": [
    "https://github.com/enterprises/github/metered_exports/1234"
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "actor": "monalisa"
}