Get usage history
ai_gateway.billing.usage_history(BillingUsageHistoryParams**kwargs) -> BillingUsageHistoryResponse
GET/accounts/{account_id}/ai-gateway/billing/usage-history
Retrieve AI Gateway usage cost, in US dollars, aggregated by hour or day for the given time range.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Parameters
Get usage history
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
response = client.ai_gateway.billing.usage_history(
account_id="account_id",
value_grouping_window="day",
)
print(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
}
}