GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In

[Budgets] Get Existing Budgets

Retrieving Budgets for a Specific Advertiser

https://api.criteo.com/legacy/marketing/v1/budgets?advertiserIds={advertiserIds}&onlyActiveCampaigns={onlyActiveCampaigns}

When no advertiser is specified, all budgets under your portfolio will be returned.

Additional filters are available to further refine the budgets returned.

For example, to retrieve all active and non-active budgets for an advertiser, you can use the onlyActiveCampaigns filter. If not specified, only active campaigns will be returned.

curl --request GET \
  --url 'https://api.criteo.com/legacy/marketing/v1/budgets?advertiserIds=1234&onlyActiveCampaigns=false' \
  --header 'Accept: application/json'

 

The API will return an array of budgets associated with the advertiser ID.

[
  {
    "advertiserId": 1234,
    "budgetId": 9999,
    "budgetName": "September 2020 Budget",
    "type": "Capped",
    "totalAmount": 10000,
    "remainingBudget": 500,
    "remainingBudgetUpdated": null,
    "active": true
  },
  {
    "advertiserId": 1234,
    "budgetId": 32222,
    "budgetName": "June 2020 Budget",
    "type": "Capped",
    "totalAmount": null,
    "remainingBudget": 0,
    "remainingBudgetUpdated": null,
    "active": false
  }
]

A full list of all available filters is available on the Budgets API Technical Reference page.

 

Retrieving Specific Budgets

You can also request the budget details for a specific budget ID, provided they are owned by advertisers in your portfolio.

https://api.criteo.com/legacy/marketing/v1/budgets?budgetIds={budgetIds}
curl --request GET \
  --url 'https://api.criteo.com/legacy/marketing/v1/budgets?budgetIds=9999' \
  --header 'Accept: application/json'