Get an AI Gateway budget instance summary
Aggregate counters for an accounting window, including total spend and the numbers of instances at or above the warning threshold and capacity. Use split_dim to aggregate only counters that match every given dimension value.
Request
- Base URLhttps://api.datadoghq.com
- Auth
- API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
- or OAuth 2Authorization code/oauth2/v1/authorizeToken URL/oauth2/v1/tokenScopesai_gateway_config_read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Budget UUID.
Query parameters
RFC3339 timestamp inside the desired accounting window. Omit to use the current window.
Keep only instance counters whose split dimension equals a value, written as <dim>=<value>, such as split_dim=user_id=<uuid>&split_dim=tag:env=prod. Dimensions use the split_dims names user_id, team_id, model, provider, and tag:<key>. Repeat the parameter to filter on several dimensions; a counter must match all of them. Each dimension may appear once and must be a per-value dimension of the budget.
Response
OK
Example response
{
"data": {
"attributes": {
"budget_id": "11111111-1111-1111-1111-111111111111",
"instance_count": 3,
"over_warning_threshold_count": 1,
"total_spend_microcents": 75000000,
"window_start": "2026-10-01T00:00:00Z"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "budget-instances-summary"
}
}Changes
Changes to this operation have not been checked yet.