[Campaigns] Get Existing Campaigns
Retrieving All Campaigns
When no advertiser is specified, all campaigns in your portfolio will be returned.
Additional filters are available to further refine the campaigns returned.
For example, to retrieve currently running campaigns in your portfolio, filter by campaignStatus
:
https://api.criteo.com/legacy/marketing/v1/campaigns?campaignStatus={campaign-status}
curl --request GET \
--url 'https://api.criteo.com/legacy/marketing/v1/campaigns?campaignStatus=Running' \
--header 'Accept: application/json'
The API will return an array of campaigns that match the provided filters:
[
{
campaignType: 'LowerFunnel',
advertiserName: 'Advertiser US',
categories: [],
budgetId: 99999,
campaignId: 1234,
campaignName: 'Web Conversion - Retargeting',
advertiserId: 1,
campaignStatus: 'Running',
campaignBid: {
bidValue: 1.00,
bidCurrency: 'USD',
bidType: 'CPC'
}
},
{
campaignType: 'MidFunnel',
advertiserName: 'Advertiser US',
categories: [],
budgetId: 99998,
campaignId: 5678,
campaignName: 'Web Consideration - Similar Audience',
advertiserId: 1,
campaignStatus: 'Running',
campaignBid: {
bidValue: 0.70,
bidCurrency: 'USD',
bidType: 'CPC'
}
}
]
A full list of all available filters is available on the Campaigns API Technical Reference page.
Retrieving Campaigns for A Specific Advertiser
By specifying one or many advertiserIds
, you can request campaigns for a specific set of Criteo advertisers.
https://api.criteo.com/legacy/marketing/v1/campaigns?campaignStatus={campaignStatus}&advertiserIds={advertiserIds}
curl --request GET \
--url 'https://api.criteo.com/legacy/marketing/v1/campaigns?advertiserIds=1234%2C5678&campaignStatus=Running' \
--header 'Accept: application/json'
Retrieving Specific Campaigns
You can also request the campaign details for a specific set of campaigns, provided they are owned by advertisers in your portfolio.
https://api.criteo.com/legacy/marketing/v1/campaigns?campaignIds={campaignIds}
curl --request GET \
--url 'https://api.criteo.com/legacy/marketing/v1/campaigns?campaignIds=1234%2C5678' \
--header 'Accept: application/json'
Retrieving One Specific Campaign
Alternatively, you can also request the details for one specific campaign by using a URL parameter, rather than a query parameter.
https://api.criteo.com/legacy/marketing/v1/campaigns/{campaignId}
curl --request GET \
--url https://api.criteo.com/legacy/marketing/v1/campaigns/1234 \
--header 'Accept: application/json'
Updated about 4 years ago