v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB

Traffic budgets

List traffic budgets

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

get/organizations/{organization}/databases/{database}/branches/{branch}/traffic/budgets

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

periodstring

Time period filter (e.g., '1h', '24h', '7d')

created_atstring

Filter by creation date range (format: 'start..end')

fingerprintstring

Filter budgets by query fingerprint

Returns the traffic budgets for the branch

typestring required

The response type. Always "list" for paginated responses.

current_pageinteger required

The current page number

next_pageinteger nullable required

The next page number, or null when this is the last page

next_page_urlstring nullable required

The next page of results, or null when this is the last page

prev_pageinteger nullable required

The previous page number, or null when this is the first page

prev_page_urlstring nullable required

The previous page of results, or null when this is the first page