> ## Documentation Index > Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt > Use this file to discover all available pages before exploring further. # List usage export jobs > List a team's usage export jobs. ## OpenAPI ````json GET /v1/teams/{team_id}/usage-exports { "openapi": "3.0.3", "info": { "title": "Data API Reference", "version": "2.0.0", "description": "API Documentation for the Supermetrics Data API including data source search capabilities. For more information, visit https://supermetrics.com.", "termsOfService": "https://supermetrics.com/terms-of-service", "contact": { "name": "Supermetrics Suppot", "email": "support@supermetrics.com", "url": "https://supermetrics.com/support" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "x-api-id": "sm-data-api", "x-audience": "public" }, "servers": [ { "url": "https://api.supermetrics.com/v2", "description": "Global production public Supermetrics Data API base path.", "x-internal": false }, { "url": "https://api.supermetrics.com", "description": "Global production public Supermetrics API base path for datasource search.", "x-internal": false } ], "tags": [ { "name": "Get data", "description": "Query data and retrieve results, fields, segments, and accounts" }, { "name": "Data Source Search", "description": "Search and discover data sources with filtering capabilities" }, { "name": "Destination Search", "description": "Search and discover destinations for your team" }, { "name": "API Usage", "description": "Retrieve API usage rollups — timeseries, top breakdowns, errors, and summary" }, { "name": "Raw Usage Data Export", "description": "Endpoints for creating and retrieving a team's raw usage reposts." }, { "name": "Campaign Management", "description": "Create, update, and manage advertising campaigns, audiences, conversions, keywords, and related assets" } ], "externalDocs": { "description": "Find out more about Supermetrics Data API", "url": "https://docs.supermetrics.com/apidocs/data-api" }, "paths": { "/v1/teams/{team_id}/usage-exports": { "servers": [ { "url": "https://api.supermetrics.com", "description": "production server", "x-internal": false } ], "get": { "summary": "List usage export jobs", "description": "List a team's usage export jobs.", "operationId": "list", "parameters": [ { "in": "path", "name": "team_id", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 9.223372036854776E+18 }, "description": "The team ID that owns the exports.", "example": 936506 }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "PENDING", "RUNNING", "READY", "FAILED" ] }, "description": "Filter exports by status (PENDING, RUNNING, READY, FAILED).", "example": "READY" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200 }, "description": "Maximum number of exports to return.", "example": 50 }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647 }, "description": "Number of exports to skip for pagination.", "example": 0 } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportsCollectionResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/PermissionDenied" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "500": { "$ref": "#/components/responses/InternalServerError" } }, "security": [ { "ApiKeyAuth": [ "usage_export_read" ] } ], "tags": [ "Raw Usage Data Export" ] } } }, "components": { "schemas": { "ExportsCollectionResponse": { "type": "object", "additionalProperties": false, "description": "A page of export summaries; the total count and navigation links live in `meta`.", "properties": { "meta": { "$ref": "#/components/schemas/MetaWithPagination" }, "data": { "$ref": "#/components/schemas/ExportsCollectionOutput" } }, "required": [ "meta", "data" ] }, "MetaWithPagination": { "type": "object", "additionalProperties": false, "description": "Response metadata including offset pagination.", "properties": { "request_id": { "type": "string", "pattern": "^[A-Za-z0-9_-]+$", "minLength": 8, "maxLength": 64, "description": "Unique identifier for the request, for tracking and debugging.", "example": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN" }, "pagination": { "$ref": "#/components/schemas/Pagination" } }, "required": [ "request_id", "pagination" ] }, "ExportsCollectionOutput": { "type": "object", "additionalProperties": false, "description": "A page of export summaries.", "properties": { "exports": { "type": "array", "maxItems": 1000, "description": "The exports on this page.", "items": { "$ref": "#/components/schemas/ExportSummaryOutput" } } } }, "ErrorResponse": { "type": "object", "description": "Standard envelope returned by all error (4xx/5xx) responses.", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "error": { "$ref": "#/components/schemas/Error" } }, "required": [ "meta", "error" ], "additionalProperties": false }, "Pagination": { "type": "object", "additionalProperties": false, "description": "Offset-based pagination metadata for list responses.", "properties": { "total_count": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 1000000000, "description": "Total number of items available across all pages.", "example": 137 }, "limit": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 200, "description": "Maximum number of items returned in this page.", "example": 50 }, "offset": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 2147483647, "description": "Number of items skipped before this page.", "example": 0 }, "links": { "$ref": "#/components/schemas/PaginationLinks" } }, "required": [ "total_count", "limit", "offset" ] }, "ExportSummaryOutput": { "type": "object", "additionalProperties": false, "description": "Lightweight export list row.", "properties": { "id": { "type": "string", "format": "uuid", "maxLength": 36, "description": "The export job id.", "example": "0f8fad5b-d9cb-469f-a165-70867728950e" }, "status": { "type": "string", "enum": [ "PENDING", "RUNNING", "READY", "FAILED" ], "description": "Current status of the export job.", "example": "READY" }, "start_date": { "type": "string", "format": "date", "nullable": true, "maxLength": 10, "description": "Inclusive UTC start date of the reporting period.", "example": "2026-01-01" }, "end_date": { "type": "string", "format": "date", "nullable": true, "maxLength": 10, "description": "Inclusive UTC end date of the reporting period.", "example": "2026-01-31" }, "product_categories": { "type": "array", "maxItems": 100, "description": "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.", "items": { "type": "string", "maxLength": 32, "pattern": "^[A-Z0-9_]{1,32}$" }, "example": [ "GADGL", "DS" ] } } }, "Meta": { "type": "object", "description": "Metadata included in every API response.", "properties": { "request_id": { "$ref": "#/components/schemas/RequestId" } }, "required": [ "request_id" ], "additionalProperties": false }, "Error": { "type": "object", "description": "Machine- and human-readable detail for a failed request.", "properties": { "code": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$", "maxLength": 100, "description": "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.", "example": "BAD_REQUEST" }, "message": { "type": "string", "maxLength": 255, "pattern": "^.+$", "description": "Short, human-readable summary of the error.", "example": "The request was invalid." }, "description": { "type": "string", "maxLength": 2048, "description": "Optional longer explanation specific to this occurrence.", "example": "The field 'display_name' must not be empty." } }, "required": [ "code", "message" ], "additionalProperties": false }, "PaginationLinks": { "type": "object", "additionalProperties": false, "description": "Navigation links for paginated collections.", "properties": { "first": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true, "description": "URL of the first page, or null when not applicable.", "example": "https://api.supermetrics.com/v1/teams/123456/usage-exports?offset=0&limit=50" }, "prev": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true, "description": "URL of the previous page, or null on the first page.", "example": null }, "next": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true, "description": "URL of the next page, or null on the last page.", "example": "https://api.supermetrics.com/v1/teams/123456/usage-exports?offset=50&limit=50" }, "last": { "type": "string", "format": "uri", "maxLength": 2048, "nullable": true, "description": "URL of the last page, or null when not applicable.", "example": null } } }, "RequestId": { "type": "string", "description": "Unique identifier for the request, for tracking and debugging.", "pattern": "^[A-Za-z0-9_-]+$", "minLength": 8, "maxLength": 64, "example": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN", "x-faker": { "random.alphaNumeric": 30 } } }, "responses": { "Unauthorized": { "description": "Unauthorized", "headers": { "WWW-Authenticate": { "$ref": "#/components/headers/WWW-Authenticate" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "meta": { "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN" }, "error": { "code": "UNAUTHORIZED", "message": "Authentication is required." } } } } }, "PermissionDenied": { "description": "Permission denied", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "meta": { "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN" }, "error": { "code": "PERMISSION_ERROR", "message": "You do not have permission to perform this action." } } } } }, "UnprocessableContent": { "description": "Unprocessable Content - invalid or corrupted data", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "meta": { "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN" }, "error": { "code": "UNPROCESSABLE_CONTENT", "message": "The content is invalid or corrupted." } } } } }, "InternalServerError": { "description": "Internal server error", "headers": { "Access-Control-Allow-Origin": { "$ref": "#/components/headers/Access-Control-Allow-Origin" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "meta": { "request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN" }, "error": { "code": "INTERNAL_SERVER_ERROR", "message": "An unexpected error occurred." } } } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API key authentication. Create API keys in the Supermetrics Hub and send\nthem in the Authorization header:\n`Authorization: Bearer `\n" } }, "headers": { "WWW-Authenticate": { "description": "Bearer token required", "schema": { "type": "string", "maxLength": 255, "pattern": "^Bearer.*" } }, "X-RateLimit-Limit": { "description": "Request limit per hour", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 10000, "example": 5000 } }, "X-RateLimit-Remaining": { "description": "Remaining requests in current window", "schema": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 10000, "example": 4999 } }, "Access-Control-Allow-Origin": { "description": "CORS header", "schema": { "type": "string", "maxLength": 255, "enum": [ "*" ], "example": "*" } } } } } ````