Get Seller Budgets
GET {{baseUrl}}/legacy/offsite-ads/budgets?status=Scheduled&withBalance=true&withSpend=true&endAfterDate=1962-03-29T08:35:04.625Z&startBeforeDate=1962-03-29T08:35:04.625Z&campaignId=-50958279&sellerId=Excepteur qui minim in&type=Excepteur qui minim in&advertiserId=-50958279
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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
status | string | Return only budgets with the given status. | |
withBalance | boolean | Return only budgets with the given status. | |
withSpend | boolean | Return budgets with any positive spend. | |
endAfterDate | string | 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. |
| startBeforeDate
| string | | Return budgets that start on or before the given date using the yyyy-MM-DD
format. |
| campaignId
| number | | Return only budgets that pay for a given campaign. |
| sellerId
| string | | Return only budgets belonging to the given seller. |
| type
| string | | Return only budgets with the given budget type. |
| advertiserId
| number | | Return only budgets belonging to the specified advertiser |