Get usage history

client.aiGateway.billing.usageHistory(, ?): BillingUsageHistoryResponse { history }

GET/accounts/{account_id}/ai-gateway/billing/usage-history

Retrieve aggregated usage meter event summaries for the given time range.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

AI Gateway WriteAI Gateway Read

ParametersExpand Collapse

params: BillingUsageHistoryParams { account_id, value_grouping_window, end_time, start_time }

account_id: string

Path param: Cloudflare account ID.

value_grouping_window: "day" | "hour"

Query param: Grouping window for usage data.

One of the following:

"day"

"hour"

end_time?: number | null

Query param: End time as Unix timestamp in milliseconds.

start_time?: number | null

Query param: Start time as Unix timestamp in milliseconds.

ReturnsExpand Collapse

BillingUsageHistoryResponse { history }

history: Array<History>

id: string

aggregated_value: number

end_time: number

start_time: number

Get usage history

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.aiGateway.billing.usageHistory({
  account_id: 'account_id',
  value_grouping_window: 'day',
});

console.log(response.history);

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "history": [
      {
        "id": "id",
        "aggregated_value": 0,
        "end_time": 0,
        "start_time": 0
      }
    ]
  },
  "success": true,
  "result_info": {
    "has_more": true,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "history": [
      {
        "id": "id",
        "aggregated_value": 0,
        "end_time": 0,
        "start_time": 0
      }
    ]
  },
  "success": true,
  "result_info": {
    "has_more": true,
    "page": 0,
    "per_page": 0,
    "total_count": 0
  }
}