GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In

Search for Campaigns

Retrieving Campaigns by Filtering

Campaigns can be retrieved by specifying filters to apply to the set of all Campaigns in your portfolio.

Using filters, you can restrict the returned results to particular advertiserIds or specific campaignIds. Filters can be combined.

For example, to retrieve the Campaigns in your portfolio related to a particular advertiser, filter by advertiserIds:

 

https://api.criteo.com/2021-07/marketing-solutions/campaigns/search
{
    "filters": {
        "advertiserIds": [ "12345" ]
    }
}

The API will return an array of Campaigns that match the provided filters:

{
    "data": [
        {
            "type": "Campaign",
            "id": "99999",
            "attributes": {
                "name": "My Campaign",
                "advertiserId": 12345,
                "objective": "BrandAwareness",
                "spendLimit": {
                    "spendLimitRenewal": "daily",
                    "spendLimitType": "capped",
                    "spendLimitAmount": {
                        "value": 123.45
                    }
                }
            }
        }
    ],
    "errors": []
}

 

Retrieving All Campaigns

When no filters are specified in the JSON payload, all Campaigns in your portfolio will be returned, as in the example below:

https://api.criteo.com/2021-07/marketing-solutions/campaigns/search
{
    "filters": {}
}

 

Retrieving One Specific Campaign

You can also fetch the details for a single Campaign using a GET request:

https://api.criteo.com/2021-07/marketing-solutions/campaigns/{campaignId}

 

The response data will be a single object containing the Campaign details.

{
    "data": {
        "type": "Campaign",
        "id": "99999",
        "attributes": { ... }
    },
    "errors": []
}