Search

Query Parameters

Data Model
{
  "accountId": "UUID (optional)",
  "periodDimension": "DAY | WEEK | MONTH | YEAR | NONE (default: DAY)",
  "from": "OffsetDateTime (required) - ISO format",
  "to": "OffsetDateTime (required) - ISO format",
  "userTypes": ["NEW", "EXISTING"],
  "domains": ["string array"],
  "countries": ["string array - ISO country codes"],
  "states": ["string array - state codes"],
  "behaviors": ["EXPRESSED", "IMPLIED", ""],
  "deviceTypes": ["MOBILE", "TABLET", "DESKTOP", "UNKNOWN"],
  "deviceOSs": ["ANDROID", "IOS", "WINDOWS", "MAC", "LINUX", "UNKNOWN"],
  "consentLocation": "string (single location)",
  "consentLocations": ["string array (multiple locations)"],
  "groupBy": ["PERIOD", "DOMAIN", "USER_TYPE", "DEVICE_TYPE", "DEVICE_OS", "COUNTRY", "BEHAVIOR", "CONSENT_LOCATION"],
  "includeCategoriesOptIns": "boolean (default: false)",
  "columns": ["string array - specific columns to return"]
}
URL ParametersNameValueDescription
accountIdValid UUID stringAccount identifier
periodDimensionString
Default: DAY

DAY,  WEEK, MONTH, YEAR, NONE		Time period grouping
fromOffsetDateTime

ISO 8601 format (e.g., 2025-01-01T00:00:00Z)

Start date/time

(Required)

toOffsetDateTime

ISO 8601 format (e.g., 2025-01-01T00:00:00Z)

End date/time

(Required)

userTypesArray[String]

NEW, EXISTING		User type filters
domainsArray[String]

Any valid domain strings		Domain filters
countries

Array[String]


ISO country codes (e.g., US, CA, GB)

Country filters
states

Array[String]


State codes (e.g., CA, NY, TX)

State/province filters
behaviors

Array[String]
 

EXPRESSED, IMPLIED, UNKNOWN

Consent behavior filters
deviceTypes

Array[String]


MOBILE, TABLET, DESKTOP, UNKNOWN

Device type filters
deviceOSs

Array[String]

 

ANDROID, IOS, WINDOWS, MAC, LINUX, UNKNOWN

Operating system filters
consentLocation

String
 

Any consent location string

Single consent location filter
consentLocations

Array[String]
 

Array of consent location strings

Multiple consent location filters
groupBy

Array[String]

 

PERIOD, DOMAIN, BEHAVIOR, USER_TYPE, DEVICE_TYPE, DEVICE_OS, COUNTRY, STATE, CONSENT_LOCATION

Grouping dimensions
includeCategoriesOptIns

Boolean


 

true, false

Include category opt-ins data

 

NOTE: This is available only when the domain filter includes a single domain, 'groupBy DOMAIN' is specified, and the domain is included in the selected columns.

columns

Array[String]

 

Any field name from AggregatedReportFact

Specific columns to return