BARB: Most-used fields#
The table below gives information about most-used fields that you can import from BARB. 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 |
|---|---|---|---|
AUDIENCE_VIEWS.audience_code |
AUDIENCE_VIEWS.audience_code |
Unique identifier for a specific audience segment or demographic group. |
metric |
AUDIENCE_VIEWS.audience_size_hundreds |
AUDIENCE_VIEWS.audience_size_hundreds |
The size of the audience segment, measured in hundreds of viewers. This data is available in the Advertising Spots Report and Audience by Time Report. |
metric |
AUDIENCE_VIEWS.category_id |
AUDIENCE_VIEWS.category_id |
Identifier for the category associated with the audience view. |
dimension |
AUDIENCE_VIEWS.description |
AUDIENCE_VIEWS.description |
A textual description of the audience segment or viewing event. |
dimension |
AUDIENCE_VIEWS.target_size_in_hundreds |
AUDIENCE_VIEWS.target_size_in_hundreds |
The target audience size for a specific advertising spot or program, measured in hundreds. |
metric |
DATE_OF_TRANSMISSION |
DATE_OF_TRANSMISSION |
The date when a television program or advertising spot was transmitted. |
dimension |
PANEL.is_macro_region |
PANEL.is_macro_region |
Indicates if the panel represents a macro-region (e.g., a larger geographical area). This data is part of the Panel information available in all report types. |
dimension |
PANEL.panel_code |
PANEL.panel_code |
Unique identifier for a BARB panel, which represents a group of households participating in viewership research. This data is part of the Panel information available in all report types and can be used as a required filter for the Spot Audience Report. |
metric |
PANEL.panel_region |
PANEL.panel_region |
The geographical region represented by the BARB panel. This data is part of the Panel information available in all report types. |
dimension |
PLATFORMS |
PLATFORMS |
The platforms on which the viewing occurred (e.g., linear TV, BVOD, SVOD, PC, tablet, smartphone). The API has been upgraded to include non-linear viewing on various platforms and devices. |
dimension |
STATION.station_code |
STATION.station_code |
Unique code for the television station. This data is part of the Station information available in the Advertising Spots Report and Audience by Time Report and can be used as a filter for these reports. |
metric |
STATION.station_name |
STATION.station_name |
The name of the television station. This data is part of the Station information available in the Advertising Spots Report and Audience by Time Report. |
dimension |
TRANSMISSION_TIME_PERIOD_DURATION_MINS |
TRANSMISSION_TIME_PERIOD_DURATION_MINS |
The duration, in minutes, of the time period for which audience data is aggregated. Common durations include 1, 5, or 15 minutes. |
metric |
TRANSMISSION_TIME_PERIOD_START.barb_polling_datetime |
TRANSMISSION_TIME_PERIOD_START.barb_polling_datetime |
The start date and time of a transmission time period, reflecting when the BARB data was initially polled or recorded. |
dimension |
TRANSMISSION_TIME_PERIOD_START.barb_reporting_datetime |
TRANSMISSION_TIME_PERIOD_START.barb_reporting_datetime |
The start date and time of a transmission time period, specifically for official BARB reporting purposes. |
dimension |
TRANSMISSION_TIME_PERIOD_START.standard_datetime |
TRANSMISSION_TIME_PERIOD_START.standard_datetime |
The start date and time of a transmission time period, presented in a standard, universally recognized datetime format. |
dimension |