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 duration of an advertising break in a program.	metric
BREAK_START_DATETIME.barb_polling_datetime	BREAK_START_DATETIME.barb_polling_datetime	The date and time when BARB began polling data for the start of an advertising break. This field is part of the Break Start Datetime data available in the Advertising Spots Report.	dimension
BREAK_START_DATETIME.barb_reporting_datetime	BREAK_START_DATETIME.barb_reporting_datetime	The date and time when BARB reported the start of an advertising break. This field is part of the Break Start Datetime data available in the Advertising Spots Report.	dimension
BREAK_START_DATETIME.standard_datetime	BREAK_START_DATETIME.standard_datetime	The standard date and time for the start of an advertising break. This field is part of the Break Start Datetime data available in the Advertising Spots Report.	dimension
BREAK_TYPE	BREAK_TYPE	The classification or type of advertising break (e.g., commercial break, sponsorship break).	dimension
BROADCASTER_SPOT_NUMBER	BROADCASTER_SPOT_NUMBER	A unique identifier assigned by the broadcaster to an advertising spot.	metric
CLEARCAST_INFORMATION.advertiser_code	CLEARCAST_INFORMATION.advertiser_code	Unique code for the advertiser as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.advertiser_name	CLEARCAST_INFORMATION.advertiser_name	The name of the advertiser as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report and can also be used as a filter for the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.buyer_code	CLEARCAST_INFORMATION.buyer_code	Unique code for the media buyer or agency as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.buyer_name	CLEARCAST_INFORMATION.buyer_name	The name of the media buyer or agency as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.clearcast_commercial_title	CLEARCAST_INFORMATION.clearcast_commercial_title	The title of the commercial as registered with Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.clearcast_telephone_number	CLEARCAST_INFORMATION.clearcast_telephone_number	The telephone number associated with the commercial, as registered with Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	metric
CLEARCAST_INFORMATION.clearcast_web_address	CLEARCAST_INFORMATION.clearcast_web_address	The web address associated with the commercial, as registered with Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.commercial_spot_length	CLEARCAST_INFORMATION.commercial_spot_length	The official length of the commercial spot in seconds, as registered with Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	metric
CLEARCAST_INFORMATION.holding_company_code	CLEARCAST_INFORMATION.holding_company_code	Unique code for the holding company associated with the advertiser, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.holding_company_name	CLEARCAST_INFORMATION.holding_company_name	The name of the holding company associated with the advertiser, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.match_group_code	CLEARCAST_INFORMATION.match_group_code	Unique code for a group of related commercials or advertisers, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	metric
CLEARCAST_INFORMATION.match_group_name	CLEARCAST_INFORMATION.match_group_name	The name of a group of related commercials or advertisers, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.product_code	CLEARCAST_INFORMATION.product_code	Unique code for the product advertised, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
CLEARCAST_INFORMATION.product_name	CLEARCAST_INFORMATION.product_name	The name of the product advertised, as provided by Clearcast. This data is part of the Clearcast Information available in the Advertising Spots Report.	dimension
COMMERCIAL_NUMBER	COMMERCIAL_NUMBER	A unique identifier for a specific commercial asset.	dimension
LOG_STATION.station_code	LOG_STATION.station_code	Unique code for the television station where the advertising spot was logged. This data is part of the Log Station information available in the Advertising Spots Report.	metric
LOG_STATION.station_name	LOG_STATION.station_name	The name of the television station where the advertising spot was logged. This data is part of the Log Station information available in the Advertising Spots Report.	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 an advertising spot within a commercial break.	dimension
PRECEDING_PROGRAMME_NAME	PRECEDING_PROGRAMME_NAME		dimension
SALES_HOUSE.sales_house_brand_description	SALES_HOUSE.sales_house_brand_description	The description of the brand or advertiser associated with a specific advertising spot, typically managed by a sales house. This correlates with the advertiser_name filter available in the Advertising Spots report.	dimension
SALES_HOUSE.sales_house_name	SALES_HOUSE.sales_house_name	The name of the sales house responsible for selling the advertising spot. This data is part of the Sales House information available in the Advertising Spots Report.	dimension
SPLIT_TRANSMISSION_INDICATOR	SPLIT_TRANSMISSION_INDICATOR	Indicates if the transmission of an advertising spot was split (e.g., aired differently in various regions).	metric
SPOT_DURATION	SPOT_DURATION	The actual duration of the advertising spot in seconds.	metric
SPOT_START_DATETIME.barb_polling_datetime	SPOT_START_DATETIME.barb_polling_datetime	The date and time when BARB began polling data for the start of an advertising spot. This field is part of the Spot Start Datetime data available in the Advertising Spots Report.	dimension
SPOT_START_DATETIME.barb_reporting_datetime	SPOT_START_DATETIME.barb_reporting_datetime	The date and time when BARB reported the start of an advertising spot. This field is part of the Spot Start Datetime data available in the Advertising Spots Report.	dimension
SPOT_START_DATETIME.standard_datetime	SPOT_START_DATETIME.standard_datetime	The standard date and time for the start of an advertising spot. This field is part of the Spot Start Datetime data available in the Advertising Spots Report.	dimension
SPOT_TYPE	SPOT_TYPE	The classification or type of advertising spot (e.g., commercial, promo).	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		dimension
TRANSMISSION_DATE	TRANSMISSION_DATE	The date on which the advertising spot or program was transmitted. This can be used as a filter (min_transmission_date, max_transmission_date) for the Advertising Spots Report and Audience by Time Report.	dimension