billing

List usage report exports

Changed on

Lists all usage report exports for an enterprise. Completed and failed report exports are available for 31 days after completion or failure. This retention period applies only to generated report records. New reports can include eligible usage data from up to 24 months ago, subject to the enterprise's creation or migration date and the report type's date-range limits. The authenticated user must be an enterprise admin or billing manager, or a custom role holder with fine-grained read access to enterprise billing. An installation access token for a GitHub App installed on the enterprise with write access to enterprise administration, or with read access to enterprise billing, can also list usage report exports.

[!NOTE] The "Enterprise administration" fine-grained permission is not available to callers. To use this API, you must use an OAuth app token or a personal access token (classic), or another supported fine-grained permission.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/settings/billing/reports
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Response

List of usage report exports

Example response

{
  "usage_report_exports": [
    {
      "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"
    }
  ]
}

Changes

  • 2022-11-28783af1c7188bRevision changes
    • warning

      added the new ai_credit enum value to the // response property for the response status