Read a batch of campaigns
POST {{baseUrl}}/marketing/v3/campaigns/batch/read?startDate=<string>&endDate=<string>&properties=<string>&properties=<string>
This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. The maximum number of items in a batch request is 50. The campaigns in the response are not guaranteed to be in the same order as they were provided in the request. If duplicate campaign IDs are provided in the request, duplicates will be ignored. The response will include only unique IDs and will be returned without duplicates.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startDate | string | Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched. | |
endDate | string | End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period. If not provided, no asset metrics will be fetched. | |
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map. | |
properties | string | A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map. |
Request Body
{"inputs"=>[{"id"=>"<string>"}, {"id"=>"<string>"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"completedAt":"\u003cdateTime\u003e","results":[{"assets":{"dolor_ef8":{"results":[{"id":"\u003cstring\u003e","metrics":{"ipsum_85":"\u003cnumber\u003e","nullad4":"\u003cnumber\u003e","elitf0":"\u003cnumber\u003e","culpa9e":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metrics":{"incididunt_fc7":"\u003cnumber\u003e","quis_ef":"\u003cnumber\u003e","occaecat_000":"\u003cnumber\u003e","ullamcob":"\u003cnumber\u003e","sint66e":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}},"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"voluptate_1":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e"},{"assets":{"ex23":{"results":[{"id":"\u003cstring\u003e","metrics":{"adipisicing_7":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metrics":{"magnacec":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}},"labore357":{"results":[{"id":"\u003cstring\u003e","metrics":{"inec2":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metrics":{"ut7d_":"\u003cnumber\u003e","in_a":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}},"mollit_130":{"results":[{"id":"\u003cstring\u003e","metrics":{"sit_9":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","metrics":{"aliqua_1c7":"\u003cnumber\u003e","anim_d33":"\u003cnumber\u003e"},"name":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"},"prev":{"before":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}},"createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","properties":{"Ut2f9":"\u003cstring\u003e","tempor158":"\u003cstring\u003e","aliquaf9":"\u003cstring\u003e"},"updatedAt":"\u003cdateTime\u003e"}],"startedAt":"\u003cdateTime\u003e","status":"COMPLETE","requestedAt":"\u003cdateTime\u003e","links":{"pariatur74":"\u003cstring\u003e"}}