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 |
BREAK_DURATION |
BREAK_DURATION |
The total length, in seconds, of the entire break during which commercials or other content were aired. |
metric |
BREAK_START_DATETIME.barb_polling_datetime |
BREAK_START_DATETIME.barb_polling_datetime |
The date and time when BARB polled the data for the start of the break, indicating when the information was collected. |
dimension |
BREAK_START_DATETIME.barb_reporting_datetime |
BREAK_START_DATETIME.barb_reporting_datetime |
The date and time when BARB reported the data for the start of the break, indicating the official reporting timestamp. |
dimension |
BREAK_START_DATETIME.standard_datetime |
BREAK_START_DATETIME.standard_datetime |
The standard date and time marking the beginning of the television break. |
dimension |
BREAK_TYPE |
BREAK_TYPE |
The classification or category of the television break, e.g., commercial break, promotional break. |
dimension |
BROADCASTER_SPOT_NUMBER |
BROADCASTER_SPOT_NUMBER |
A unique identification number assigned by the broadcaster to a specific advertising spot. |
metric |
CLEARCAST_INFORMATION.advertiser_code |
CLEARCAST_INFORMATION.advertiser_code |
A unique code identifying the advertiser associated with the clearcast information for a commercial. |
dimension |
CLEARCAST_INFORMATION.advertiser_name |
CLEARCAST_INFORMATION.advertiser_name |
The name of the advertiser associated with the clearcast information for a commercial. This field is a filter for Advertising Spots. |
dimension |
CLEARCAST_INFORMATION.buyer_code |
CLEARCAST_INFORMATION.buyer_code |
A unique code identifying the media buyer associated with the clearcast information for a commercial. |
dimension |
CLEARCAST_INFORMATION.buyer_name |
CLEARCAST_INFORMATION.buyer_name |
The name of the media buyer associated with the clearcast information for a commercial. This field is a filter for Advertising Spots. |
dimension |
CLEARCAST_INFORMATION.clearcast_commercial_title |
CLEARCAST_INFORMATION.clearcast_commercial_title |
The official title of the commercial as registered with Clearcast. |
dimension |
CLEARCAST_INFORMATION.clearcast_telephone_number |
CLEARCAST_INFORMATION.clearcast_telephone_number |
The telephone number provided in the clearcast information for the commercial, typically for viewer enquiries. |
metric |
CLEARCAST_INFORMATION.clearcast_web_address |
CLEARCAST_INFORMATION.clearcast_web_address |
The web address provided in the clearcast information for the commercial, typically for viewer information or product details. |
dimension |
CLEARCAST_INFORMATION.holding_company_code |
CLEARCAST_INFORMATION.holding_company_code |
A unique code identifying the holding company associated with the clearcast information for a commercial. |
dimension |
CLEARCAST_INFORMATION.holding_company_name |
CLEARCAST_INFORMATION.holding_company_name |
The name of the holding company associated with the clearcast information for a commercial. |
dimension |
CLEARCAST_INFORMATION.match_group_code |
CLEARCAST_INFORMATION.match_group_code |
A unique code used to group related commercials or campaigns together based on clearcast information. |
metric |
CLEARCAST_INFORMATION.match_group_name |
CLEARCAST_INFORMATION.match_group_name |
The name of the match group associated with the clearcast information for a commercial. |
dimension |
CLEARCAST_INFORMATION.product_code |
CLEARCAST_INFORMATION.product_code |
A unique code identifying the product advertised in the commercial, as per clearcast information. |
dimension |
CLEARCAST_INFORMATION.product_name |
CLEARCAST_INFORMATION.product_name |
The name of the product advertised in the commercial, as per clearcast information. |
dimension |
COMMERCIAL_NUMBER |
COMMERCIAL_NUMBER |
A unique identification number for a specific commercial broadcast. |
dimension |
LOG_STATION.station_code |
LOG_STATION.station_code |
A unique code identifying the television station or channel that aired the content. This field is a filter for Advertising Spots and Audience by Time. |
metric |
LOG_STATION.station_name |
LOG_STATION.station_name |
The name of the television station or channel that aired the content. |
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 |
POSITION_IN_BREAK |
POSITION_IN_BREAK |
The sequential position of the advertising spot within a given break. |
dimension |
PRECEDING_PROGRAMME_NAME |
PRECEDING_PROGRAMME_NAME |
The title of the television programme that was broadcast immediately before the advertising break or spot. |
dimension |
SALES_HOUSE.sales_house_brand_description |
SALES_HOUSE.sales_house_brand_description |
A description of the brand or portfolio managed by the sales house. This field is likely a direct copy or aggregation of SPOT_EVENT.sales_house.sales_house_brand_description. |
dimension |
SALES_HOUSE.sales_house_name |
SALES_HOUSE.sales_house_name |
The name of the sales house responsible for selling the advertising spot. |
dimension |
SPLIT_TRANSMISSION_INDICATOR |
SPLIT_TRANSMISSION_INDICATOR |
An indicator that denotes if the transmission of the advertising spot was split across different regions or versions. |
metric |
SPOT_DURATION |
SPOT_DURATION |
The actual length, in seconds, of an individual advertising spot. |
metric |
SPOT_START_DATETIME.barb_polling_datetime |
SPOT_START_DATETIME.barb_polling_datetime |
The date and time when BARB polled the data for the start of the advertising spot, indicating data collection time. |
dimension |
SPOT_START_DATETIME.barb_reporting_datetime |
SPOT_START_DATETIME.barb_reporting_datetime |
The date and time when BARB reported the data for the start of the advertising spot, indicating the official reporting timestamp. |
dimension |
SPOT_START_DATETIME.standard_datetime |
SPOT_START_DATETIME.standard_datetime |
The standard date and time marking the beginning of the advertising spot. |
dimension |
SPOT_TYPE |
SPOT_TYPE |
The classification or category of the advertising spot, e.g., commercial, sponsor billboard. |
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 |
SUCCEEDING_PROGRAMME_NAME |
SUCCEEDING_PROGRAMME_NAME |
The title of the television programme that was broadcast immediately after the advertising break or spot. |
dimension |
TRANSMISSION_DATE |
TRANSMISSION_DATE |
The date on which the advertising spot or program was transmitted. |
dimension |