AudienceReport: Most-used fields#
The table below gives information about most-used fields that you can import from AudienceReport. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
affinity |
affinity |
A metric indicating the common audience affinity at the campaign or report item level. |
metric |
campaign_id |
campaign_id |
A unique identifier for the campaign. |
dimension |
campaign_name |
campaign_name |
The human-readable name of the campaign. |
dimension |
campaign_status |
campaign_status |
The current status of the campaign, indicating its state such as active or completed. |
dimension |
cid |
cid |
The unique prefix for a trackpoint, often used in combination with an event type and tailcode to form an event identifier. |
dimension |
countryCode |
countryCode |
The two-character country code (ISO 3166-1) representing the country relevant to the campaign or report. |
dimension |
countryEvents |
countryEvents |
The total number of events that originated from the target country for the campaign. |
metric |
customerId |
customerId |
The unique identifier for the AudienceReport customer or company associated with the campaign data. |
metric |
date |
date |
The specific date for which event data was registered or reported. |
dimension |
estimatedUniqueVisitors |
estimatedUniqueVisitors |
A close estimate of the number of unique individuals exposed to the campaign or who triggered a report item event. |
metric |
eventCount |
eventCount |
The total number of events recorded for a specific item or type during a given period. |
metric |
eventType |
eventType |
The classification of an event, such as ‘Impression’, ‘Click’, or ‘VideoComplete’. |
dimension |
events |
events |
The total number of collected events, such as impressions or clicks, for a campaign or report item. |
metric |
evid |
evid |
A unique string identifier for the report item, typically structured as [eventType]:[cid]:[tailcode]. |
dimension |
frequency |
frequency |
The average number of times each unique visitor was exposed to the campaign or triggered a report item event. |
metric |
marginal |
marginal |
The marginal increase in a metric from one week to the next. |
metric |
name |
name |
The name of an AudienceReport entity, such as an account, channel, country, platform, report, or an item within a campaign hierarchy (e.g., campaign, insertion order, creative). |
dimension |
providerId |
providerId |
A unique identifier for the provider of a custom segment. |
dimension |
reach |
reach |
The percentage of the target group that was exposed to the campaign or report item. |
metric |
reachContribution |
reachContribution |
The unique reach for a report item, excluding any overlapping reach from other items. |
metric |
reachPersons |
reachPersons |
The number of unique individuals reached by the campaign or report item. |
metric |
sampleSize |
sampleSize |
The exact number of recognized panelists used in the calculation for audience measurement. |
metric |
sampleSizeStatus |
sampleSizeStatus |
Indicates whether the sample size is sufficient for reliable extrapolation of the data. |
dimension |
share |
share |
The percentage of events originating from a specific source or segment relative to the total campaign events. |
metric |
start_date |
start_date |
The start date of the campaign or reporting period in ISO 8601 format (yyyy-MM-dd). |
dimension |
tailcode |
tailcode |
The suffix of a trackpoint code, often used with CID and event type to identify a specific event. |
dimension |
targetCountry |
targetCountry |
The two-character country code (ISO 3166-1) that represents the target geographic area for the campaign. |
dimension |
targetEvents |
targetEvents |
The total number of events recorded within the defined target group. |
metric |
targetEventsPercentage |
targetEventsPercentage |
The percentage of events that occurred within the target group, relative to the total campaign events. |
metric |
targetGroupSize |
targetGroupSize |
The total size of the selected demographic target group for the campaign. |
metric |
totalEventsPercentage |
totalEventsPercentage |
The percentage of total campaign events that occurred within the target group. |
metric |
trackpointId |
trackpointId |
A unique identifier for a specific trackpoint, used for event tracking. |
dimension |
trp |
trp |
Target Rating Points (TRP), a measure of the total number of exposures to the target audience. |
metric |
week |
week |
The week number within the year for which the data is reported. |
metric |
weekISO |
weekISO |
The ISO standard week number, formatted as ‘YYYY-Www’, e.g., ‘2015-W04’. |
dimension |
weekly |
weekly |
Accumulated statistics and metrics for the campaign, broken down by week. |
dimension |