List usage export jobs

Updated on Sep 10, 2026
Published on Aug 31, 2026

Get

/v1/teams/{team_id}/usage-exports

List a team's usage export jobs.

Security

HTTP

Type bearer

API key authentication. Create API keys in the Supermetrics Hub and send them in the Authorization header: Authorization: Bearer <your-api-key>

Path parameters

team_id

integer (int64) Required

The team ID that owns the exports.

Minimum1

Maximum9223372036854776000

Example936506

Query parameters

status

string

Filter exports by status (PENDING, RUNNING, READY, FAILED).

Valid values[ "PENDING", "RUNNING", "READY", "FAILED" ]

ExampleREADY

limit

integer (int32)

Maximum number of exports to return.

Minimum1

Maximum200

Example50

offset

integer (int32)

Number of exports to skip for pagination.

Minimum0

Maximum2147483647

Example0

Responses

200

Successful response

Expand All

object

A page of export summaries; the total count and navigation links live in meta.

meta

object (MetaWithPagination)

Response metadata including offset pagination.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

pagination

object (Pagination)

Offset-based pagination metadata for list responses.

total_count

integer (int64)

Total number of items available across all pages.

Minimum0

Maximum1000000000

Example137

limit

integer (int32)

Maximum number of items returned in this page.

Minimum1

Maximum200

Example50

offset

integer (int32)

Number of items skipped before this page.

Minimum0

Maximum2147483647

Example0

links

object (PaginationLinks)

Navigation links for paginated collections.

first

string (uri) | null

URL of the first page, or null when not applicable.

Max length2048

Examplehttps://api.supermetrics.com/v1/teams/123456/usage-exports?offset=0&limit=50

string (uri) | null

URL of the previous page, or null on the first page.

Max length2048

Example

string (uri) | null

URL of the next page, or null on the last page.

Max length2048

Examplehttps://api.supermetrics.com/v1/teams/123456/usage-exports?offset=50&limit=50

last

string (uri) | null

URL of the last page, or null when not applicable.

Max length2048

Example

data

object (ExportsCollectionOutput)

A page of export summaries.

exports

Array of object (ExportSummaryOutput)

The exports on this page.

Max items1000

object

Lightweight export list row.

string (uuid)

The export job id.

Max length36

Example0f8fad5b-d9cb-469f-a165-70867728950e

status

string

Current status of the export job.

Valid values[ "PENDING", "RUNNING", "READY", "FAILED" ]

ExampleREADY

start_date

string (date) | null

Inclusive UTC start date of the reporting period.

Max length10

Example2026-01-01

end_date

string (date) | null

Inclusive UTC end date of the reporting period.

Max length10

Example2026-01-31

product_categories

Array of string

The product categories this export was created for. Not constrained to the request enum: a job created before a category was retired keeps returning that category, so responses may carry values the request no longer accepts.

Max items100

Example[ "GADGL", "DS" ]

string

Max length32

Pattern^[A-Z0-9_]{1,32}$

401

Unauthorized

Headers

WWW-Authenticate

string

Bearer token required

Max length255

Pattern^Bearer.*

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

403

Permission denied

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "PERMISSION_ERROR",
    "message": "You do not have permission to perform this action."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

422

Unprocessable Content - invalid or corrupted data

Headers

X-RateLimit-Limit

integer

Request limit per hour

Minimum1

Maximum10000

Example5000

X-RateLimit-Remaining

integer

Remaining requests in current window

Minimum0

Maximum10000

Example4999

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "UNPROCESSABLE_CONTENT",
    "message": "The content is invalid or corrupted."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

500

Internal server error

Headers

Access-Control-Allow-Origin

string

CORS header

Valid values[ "*" ]

Max length255

Example*

{
  "meta": {
    "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
  },
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred."
  }
}

Expand All

object

Standard envelope returned by all error (4xx/5xx) responses.

meta

object (Meta)

Metadata included in every API response.

request_id

string

Unique identifier for the request, for tracking and debugging.

Min length8

Max length64

Pattern^[A-Za-z0-9_-]+$

ExampleBXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN

error

object (Error)

Machine- and human-readable detail for a failed request.

code

string

Max length100

Pattern^[A-Z][A-Z0-9_]*$

ExampleBAD_REQUEST

message

string

Short, human-readable summary of the error.

Max length255

Pattern^.+$

ExampleThe request was invalid.

description

string

Optional longer explanation specific to this occurrence.

Max length2048

ExampleThe field 'display_name' must not be empty.

Was this article helpful?