General

Our "Reporting" endpoints allow for bulk operations. Specifically, through the two following endpoints:

You will be able to send us several CampaignIds or LineItemIds, with a maximum of 50 IDs per call.

To do so, please use the following attributes and terminology in one or the other endpoint (example below for the POST /report/campaigns endpoint, the same applies to the line-item endpoint):

📘

When requesting a single ID then use: "id": "CampaignId1"

OR

When requesting several IDs then use "ids": ["CampaignId1", "CampaignId2", ..., "CampaignIdn"]

⚠️

Important

• Please make sure to not use id and ids in the same call, as this will lead to an invalid request.
• There is a 100,000-row limit for report output to keep in mind when making a bulk report request.

Error Codes

When sending more than 50 IDs, you will get the following 400 Bad request HTTP Response:

{
    "errors": [
        {
            "code": "exceeded-ids-cap",
            "title": "Requests are capped for 50 unique ids, 51 were provided",
            "type": "validation",
            "traceId": "aa47dd83-8ca9-4a79-a179-ad5be6932ff1",
            "instance": "/api/v1/reports/line-item",
            "detail": "ids Requests are capped for 50 unique ids, 51 were provided (Value: \"1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51\")",
            "source":{
                "ids": "data/attributes/ids"
            }
        }
    ]
}

This Contains:

• Error code: exceeded-ids-cap

• Error title: Requests are capped for 50 unique ids, {count of ids requested} were provided

• Error Type: validation

• A traceId: aa47dd83-8ca9-4a79-a179-ad5be6932ff1

• Instance: the report requested (here /api/v1/reports/line-item)

• Detail: Title with a list of requested IDs

• Source: The parameter that caused the error (IDs in this case)