Generate Async Campaigns Report
POST {{baseUrl}}/2023-01/retail-media/reports/campaigns
Return an asynchronous Campaigns Report
Request Body
{"data"=>{"type"=>"<string>", "attributes"=>{"endDate"=>"<dateTime>", "startDate"=>"<dateTime>", "ids"=>["<string>", "<string>"], "id"=>"<string>", "campaignType"=>"onSiteDisplays", "salesChannel"=>"offline", "format"=>"json-compact", "reportType"=>"summary", "clickAttributionWindow"=>"none", "viewAttributionWindow"=>"none", "dimensions"=>["campaignId", "salesChannel"], "metrics"=>["cpc", "cpc"], "timezone"=>"UTC"}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"attributes":{"status":"success","rowCount":"\u003cinteger\u003e","fileSizeBytes":"\u003cinteger\u003e","md5CheckSum":"\u003cstring\u003e","createdAt":"\u003cstring\u003e","expiresAt":"\u003cstring\u003e","message":"\u003cstring\u003e","id":"\u003cstring\u003e"},"id":"\u003cstring\u003e","type":"\u003cstring\u003e"},"warnings":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"dolor_49":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"dolor_4":"\u003cstring\u003e","exercitation_7de":"\u003cstring\u003e","idb":"\u003cstring\u003e","ex03":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"errors":[{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"in8":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","traceIdentifier":"\u003cstring\u003e","type":"access-control","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"ad_74":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}