/legacy/offsite-ads/budgets

Return a collection of budgets filtered by optional filter parameters. If all parameters are omitted the entire collection to which the user has access is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter criteria if multiple parameters are used.

Date filter. Filtering can return only budgets that were active for a date range by specifying the startBeforeDate and endAfterDate. Leaving off the startBeforeDate value makes budgets with any startDate qualify, whereas when leaving off the endAfterDate value will only return budgets whose endDate has not already passed. To get budgets that were active on a specific date, set both values to that day.

Spend. If the endAfterDate is supplied, the spend excludes spend that happened after that date. In the case of a daily budget, only the spend for the final day is displayed.

See the budgets endpoint for additional details.

Query Params
string
enum

Return only budgets with the given status.

Allowed:
boolean

Return only budgets with the given status.

boolean

Return budgets with any positive spend.

date-time

Return budgets that end after the given date using the yyyy-MM-DD format. If param is not provided, default behavior is to only return budgets that have not yet ended.

date-time

Return budgets that start on or before the given date using the yyyy-MM-DD format.

int32

Return only budgets that pay for a given campaign.

string

Return only budgets belonging to the given seller.

string

Return only budgets with the given budget type.

int32

Return only budgets belonging to the specified advertiser

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

429

Client Error

500

Server Error

Language
Credentials
OAuth2
Response
Choose an example:
text/plain
application/json
text/json