CIcircleci
Usage

Create a usage export

Submits a request to create a usage export for an organization.

post/organizations/{org_id}/usage_export_job

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/organizations/{org_id}/usage_export_job
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Request body

startstring date-time required

The start date & time (inclusive) of the range from which data will be pulled. Must be no more than one year ago.

endstring date-time required

The end date & time (inclusive) of the range from which data will be pulled. Must be no more than 31 days after start.

shared_org_idsstring[]

Response

Usage export created successfully

usage_export_job_idstring uuid required
state'created' | 'processing' | 'failed' | 'completed' required
startstring date-time required
endstring date-time required
download_urlsstring[] required

A list of pre signed urls that the client can use to download the results of a Usage Export.

Changes

No recorded changes to this operation across all 1 revision of this API.