Get API Usage Statistics

Get credit usage and API call statistics. Shows request counts by endpoint.

GET /v1/usage

cURL

PowerShell

curl -X GET "https://api.getcatalog.ai/v1/usage?period=7d&page_size=5" \
  -H "x-api-key: $CATALOG_API_KEY"

Success Response

{
  "data": [
    {
      "path": "/v1/listings",
      "total_calls": 9
    },
    {
      "path": "/v1/affiliate",
      "total_calls": 8
    },
    {
      "path": "/v1/vendors",
      "total_calls": 6
    },
    {
      "path": "/v1/agentic-search",
      "total_calls": 4
    },
    {
      "path": "/v1/collections",
      "total_calls": 4
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 5,
    "total_items": 16,
    "total_pages": 4,
    "has_next": true,
    "has_prev": false
  },
  "meta": {
    "period": "7d"
  }
}

When to use: Monitor your API consumption and track usage patterns. See Rate Limits for quota information.

Request

x-api-key · string · required

Your API key for authentication

Query Parameters

period · string · default: "30d"

Time period for usage statistics

Valid Values:

• 24h - Last 24 hours
• 7d - Last 7 days
• 30d - Last 30 days (default)
• 90d - Last 90 days
• all - All time usage

page · number · default: "1"

Page number for pagination (1-indexed)

page_size · number · default: "20"

Number of items per page (maximum 100)

Response

data · array

Array of usage statistics by endpoint path

Show Usage Statistics

path · string

API endpoint path (e.g., “/v1/agentic-search”, “/v1/products”)

total_calls · number

Total number of API calls made to this endpoint

pagination · object

Pagination metadata for the results

Show Pagination Object

page · number

Current page number

page_size · number

Number of items per page

total_items · number

Total number of items across all pages

total_pages · number

Total number of pages available

has_next · boolean

Whether there is a next page

has_prev · boolean

Whether there is a previous page

meta · object

Response metadata

Show Meta Properties

period · string

Echo back the requested time period

request_id · string

Unique request identifier for support purposes

cURL

PowerShell

curl -X GET "https://api.getcatalog.ai/v1/usage?period=7d&page_size=5" \
  -H "x-api-key: $CATALOG_API_KEY"

Success Response

{
  "data": [
    {
      "path": "/v1/listings",
      "total_calls": 9
    },
    {
      "path": "/v1/affiliate",
      "total_calls": 8
    },
    {
      "path": "/v1/vendors",
      "total_calls": 6
    },
    {
      "path": "/v1/agentic-search",
      "total_calls": 4
    },
    {
      "path": "/v1/collections",
      "total_calls": 4
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 5,
    "total_items": 16,
    "total_pages": 4,
    "has_next": true,
    "has_prev": false
  },
  "meta": {
    "period": "7d"
  }
}