Generate Analytics Report File

This generates an analytics report file for download.

POST /analytics/generate-file

MethodPOST
URLhttps://api.trustarc.com/api/ccm-reporting/analytics/generate-file
HeadersAuthorization: Bearer <access_token from 'Token Access' section>
Sample Request
{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "periodDimension": "DAY",
  "from": "2025-01-01T00:00:00Z",
  "to": "2025-01-31T23:59:59Z",
  "userTypes": ["NEW", "EXISTING"],
  "domains": ["example.com", "test.com"],
  "countries": ["US", "CA"],
  "states": ["CA", "NY"],
  "behaviors": ["EXPRESSED", "IMPLIED"],
  "deviceTypes": ["DESKTOP", "MOBILE"],
  "deviceOSs": ["WINDOWS", "ANDROID"],
  "consentLocation": "banner",
  "consentLocations": ["banner", "modal"],
  "groupBy": ["DOMAIN", "USER_TYPE"],
  "includeCategoriesOptIns": false,
  "columns": ["impressions", "uniqueImpressions"]
}
Sample Success Responsetrue
Success ResponseCode: 202 Accepted
Error Response

Code: 400 Bad Request

Code: 401 Unauthorized

Code: 403 Forbidden

Code: 404 Not Found