Teads Developer Portal

Pass dimensions in the dimensions array of a create report request. Dimensions determine how report rows are grouped and which descriptive columns are returned; combine them with metrics and, optionally, filters.

Publisher dimensions

Dimension	Definition
`publisher`	Aggregates statistics for all websites, or all publishers for an ad network.
`website`	Aggregates statistics for all placements on a website; returns website ID and name.
`website_domain`	The website domain.
`page`	Page ID and name. A page is integrated as a generic tag and contains a Teads page ID.
`placement`	Placement ID and name; the space where campaign data is served across scripts, pages, formats, and environments.
`hb_provider`	Header bidding provider. `null` or `N/A` means the integration is not header bidding.

Programmatic dimensions

Dimension	Definition
`adsource`	Parent of a connection, usually a DSP, VAST-compliant source, or marketplace.
`connection`	A configured ad source connection for an SSP entity.
`connection_type`	Connection type: `rtb` or `fixed`.
`connection_is_moat`	Whether Moat is activated on the connection.
`scenario_id`	Scenario identifier.
`scenario_name`	Scenario name.

Scenarios are sets of connection configurations and are intended for SSP statistics.

Campaign dimensions

Dimension	Definition
`advertiser`	Advertiser ID and name.
`advertiser_name`	Advertiser name.
`advertiser_domain`	Advertiser domain.
`agency`	Agency ID and name.
`agency_name`	Agency name.
`ad`	Ad ID and name; aggregates statistics for its insertions.
`ad_type`	Ad type: managed, monitoring, or agency.
`ad_is_moat`	Whether Moat is activated on the ad.
`ad_is_test`	Whether the ad is configured as a test.
`insertion`	Insertion ID and name.
`insertion_type`	Direct sold, intragroup, or self-serve.
`insertion_budget`	Insertion budget without currency.
`insertion_start_date`	Insertion start date.
`insertion_end_date`	Insertion end date.
`insertion_volume_value`	Volume limit count.
`insertion_volume_event`	Event associated with the volume limit, such as `start`.
`insertion_price_publisher`	Buying price configured for the publisher.
`insertion_price_publisher_cpm`	Publisher price expressed as cost per mille.
`insertion_price_publisher_currency`	Currency of the publisher price.
`insertion_price_advertiser`	Selling price configured for the advertiser.
`insertion_price_advertiser_event`	Event used for the advertiser selling price, such as `complete`.
`creative`	Creative ID and name; the media element associated with an ad.

Temporal dimensions

Dimension
`hour`
`day`
`week`
`month`
`quarter`
`year`

Audience and environment dimensions

Dimension	Definition
`country`	Country code and name.
`country_code`	Country code.
`country_continent`	Country continent.
`device`	Viewer device extracted from the user agent: phone, IPTV, tablet, or PC.
`browser`	Viewer browser, such as Chrome, Internet Explorer, Firefox, or Safari.
`operating_system`	Viewer operating system, such as Windows, macOS, Linux, or Android.

Demand dimensions

Demand dimensions combine common connection and insertion attributes:

Dimension	Definition
`demand`	Connection or insertion, depending on the row.
`demand_source`	Programmatic or IO-based campaign.
`demand_id`	Connection or insertion ID.
`demand_name`	Connection or insertion name.
`demand_category`	Format mode of the connection or insertion.
`demand_start_mode`	Start mode of the connection or insertion.
`demand_type`	Buying type of the connection or insertion.
`demand_rule`	Connection or insertion rule.
`demand_rule_id`	Rule identifier.
`demand_rule_is_exelate`	Whether Exelate targeting is enabled.
`demand_rule_is_grapeshot`	Whether Grapeshot targeting is enabled.
`demand_rule_is_emetriq`	Whether Emetriq targeting is enabled.
`demand_rule_is_bluekai`	Whether Bluekai targeting is enabled.

Format and studio dimensions

Dimension	Definition
`format_position`	Creative position: inRead, inBoard, Smart, or Slider.
`format_size`	Creative size: Landscape, Square, Vertical, or MPU.
`format_creative_type`	Creative type, such as Video, 360, Carousel, Scroller, or Flow.
`format_creative_type_family`	Creative family: Video, Viewable Display, or Standard Display.
`format`	Deprecated legacy format value: `inRead` or `inBoard`.
`studio_creative_id`	Teads Studio creative ID, when used.
`studio_segment`	Teads Studio segment, when used.

Unique visitor flag

uv is a flag rather than a dimension. It deduplicates selected metrics by distinct visitor using cookies. The source documentation marks uv as deprecated starting January 1, 2024.

Dimensions

On this page