Report dimensions
Overview
This article provides definitions for the dimensions available in Maestro’s Instant Insights, Instant Report Builder, and Reporting API.
Report dimensions
Columns
The list in section “Dimension list”, later in this document, contains each dimension with the following details:
- Name: the dimension name, mainly named according to the name used in Instant Insights and Instant Report Builder.
- Instant Insights API name: the dimension name used in the Instant Insights API.
- Instant Report Builder API name: the dimension name used in the Instant Report Builder API.
- Use cases: the context in which the dimension can be used, corresponding to the Views in Instant Report Builder and Instant Insights. For more details, see the following section “Use cases”.
- Definition: the definition of the dimension.
Use cases
In the reporting API, the Use case is the context in which a dimension can be used. In the Instant Insights and Instant Report Builder UIs, each Use case corresponds to a View that can be selected in the top right corner in these two UIs.
For the sake of brevity, the dimension list uses abbreviations in the column “Use cases”. The following table contains all View/Use case names with their abbreviations:
| Use case name #1 in Reporting API | Use case name #2 in Reporting API | View name in IRB/Instant Insights | Use case abbreviation in dimension list |
|---|---|---|---|
| demandcontentmetadata | ContentMetadata | Content Metadata | c |
| demandmediabuying | MediaBuying | Activation | m |
| demandprogrammatic | RTB | Programmatic | p |
| demandsegment | ForecastDMKP | Data Marketplace | s |
| scope3 | Sustainability | s3 |
Dimension list
For a better understanding of the columns in this list, see sections “Columns” and "Use cases", earlier in this document.
| Name | Instant Insights API name | Instant Report Builder API name | Use cases | Definition |
|---|---|---|---|---|
| Ad Break Type | adBreakTypeId | AdBreakTypeId | c, m, p, s | The type Id of an in-stream video ad break (before, within or after the video content). 1: pre-roll 2: mid-roll 3: post-roll |
| Ad Break Type | adBreakTypeName | AdBreakTypeName | c, m, p, s | The type name of an in-stream video ad break (before, within or after the video content). 1: pre-roll 2: mid-roll 3: post-roll |
| Advertiser Domain | advertiserDomain | AdvertiserDomainName | c, m, p, s3 | The domain of the advertiser, whose ad was served. |
| App/Site | appOrSiteId | AppSiteChannelId | p, s | The Id of the app or site of the publisher, as defined in Equativ’s Monetization Platform. |
| App/Site | appOrSiteName | AppSiteChannelName | p, s | The name of the app or site of the publisher, as defined in Equativ’s Monetization Platform. |
| App/Site Domain | appOrSiteDomain | BundleDomain | c, m, p, s, s3 | The domain of the publisher. For mobile web, it is the site's domain (excluding http://, www., and query parameters). For apps, it is the app’s bundle ID. |
| Auction Package | auctionPackageExternalDealId | AuctionPackageExternalDealId | c, m, p, s, s3 | The deal ID of an Auction package deal. Auction packages are created and managed by Equativ or by curators/buyers using the Maestro platform. |
| Auction Package | auctionPackageDealId | AuctionPackageInternalDealId | c, m, p, s, s3 | The internal deal ID of an Auction package deal. Auction packages are created and managed by Equativ or by curators/buyers using the Maestro platform. |
| Auction Package | auctionPackageDealName | AuctionPackageDealName | c, m, p, s, s3 | The name of an Auction package deal. Auction packages are created and managed by Equativ or by curators/buyers using the Maestro platform. |
| Billed Audience Provider | billedAudienceSegmentProviderId | BilledAudienceSegmentProviderId | s | The provider Id of the audience segment, billed by Equativ.¹ |
| Billed Audience Provider | billedAudienceSegmentProviderName | BilledAudienceSegmentProviderName | s | The provider name of the audience segment, billed by Equativ.¹ |
| Billed Audience Segment | billedAudienceSegmentId | BilledAudienceSegmentId | s | The Id of the audience segment, billed by Equativ.¹ |
| Billed Audience Segment | billedAudienceSegmentName | BilledAudienceSegmentName | s | The name of the audience segment, billed by Equativ.¹ |
| Billed Semantic Provider | billedSemanticSegmentProviderId | BilledSemanticSegmentProviderId | s | The provider Id of the semantic segment, billed by Equativ.¹ |
| Billed Semantic Provider | billedSemanticSegmentProviderName | BilledSemanticSegmentProviderName | s | The provider name of the semantic segment, billed by Equativ.¹ |
| Billed Semantic Segment | billedSemanticSegmentId | BilledSemanticSegmentId | s | The Id of the semantic segment, billed by Equativ.¹ |
| Billed Semantic Segment | billedSemanticSegmentName | BilledSemanticSegmentName | s | The name of the semantic segment, billed by Equativ.¹ |
| Browser Parent | browserParentId | BrowserParentId | m, p | The user's parent browser Id. |
| Browser Parent | browserParentName | m, p | The user's parent browser name. | |
| Campaign | buyCampaignId | DspCampaignId | m, s3 | The Id of a campaign, created in the Activation module. |
| Campaign | buyCampaignName | DspCampaignName | m, s3 | The name of a campaign, created in the Activation module. |
| Consent String Status | consentStringStatusId | ConsentStringStatusId | m, p, s | The status Id of the TCF consent string: -1: N/A (malformed/invalid) 0: Empty 1: Ok 2: Fallback consent connected TV; a simplified consent string for connected TV (CTV) apps where consent to or rejection of all Purposes / Features / Special Features is sent; usually, in CTV environments, granular consent management by Purpose / Feature / Special Feature is not supported because CMPs are not available. |
| Consent String Status | consentStringStatusName | ConsentStringStatusName | m, p, s | The status name of the TCF consent string: -1: N/A (malformed/invalid) 0: Empty 1: Ok 2: Fallback consent connected TV; a simplified consent string for connected TV (CTV) apps where consent to or rejection of all Purposes / Features / Special Features is sent; usually, in CTV environments, granular consent management by Purpose / Feature / Special Feature is not supported because CMPs are not available. |
| Content Category | contentCategory | ContentCategory | c | The category of the content surrounding the ad, declared by the publisher as part of content metadata. |
| Content Context | contentContextName | ContentContext | c | The context of the content surrounding the ad, declared by the publisher as part of content metadata. |
| Content Genre | contentGenre | ContentGenre | c | The genre of the content surrounding the ad, declared by the publisher as part of content metadata. |
| Content Id | contentId | ContentId | c | The Id of the content surrounding the ad, declared by the publisher as part of content metadata. |
| Content Language | contentLanguage | ContentLanguage | c | The language, conforming to ISO-639-1-alpha-2, of the content surrounding the ad, declared by the publisher as part of content metadata. |
| Cookieless Traffic | isUserIdLess | IsUserIdLess | m, p | A boolean indicating if the auction doesn't have any identifier for the user. |
| Country | countryId | CountryId | c, m, p, s, s3 | The country Id of the ad opportunity, following the ISO 3166-1 standard. |
| Country | countryName | CountryName | c, m, p, s, s3 | The country name of the ad opportunity, following the ISO 3166-1 standard. |
| Creative | creativeId | RtbCreativeId | m | The creative Id, as configured in the Activation module. |
| Creative | creativeName | RtbCreativeName | m | The creative name, as configured in the Activation module. |
| Creative Size | creativeSize | CreativeSize | m, p | The dimensions of the creative in format Width*Height. |
| Device Type | deviceTypeId | DeviceTypeId | c, m, p, s, s3 | The type Id of the device. 1: Desktop 2: Tablet 3: Smartphone 4: TV 5: Set Top Box 6: Game console 7: Other connected device |
| Device Type | deviceTypeName | DeviceTypeName | c, m, p, s, s3 | The type name of the device. 1: Desktop 2: Tablet 3: Smartphone 4: TV 5: Set Top Box 6: Game console 7: Other connected device |
| Environment Type | environmentTypeId | EnvironmentTypeId | c, m, p, s, s3 | The type Id of the environment. 0: Web 1: Mobile Web 2: App |
| Environment Type | environmentTypeName | EnvironmentTypeName | c, m, p, s, s3 | The type name of the environment. 0: Web 1: Mobile Web 2: App |
| Format Type | formatTypeId | c, m, p, s | The Id of the impression type. 0: Banner 1: VideoInStream 2: Native 3: VideoOutStream 4: Unknown 5: Audio |
|
| Format Type | formatTypeName | c, m, p, s | The name of the impression type. 0: Banner 1: VideoInStream 2: Native 3: VideoOutStream 4: Unknown 5: Audio |
|
| GDPR Applies | gdprApplies | GdprApplies | m, p, s | A boolean indicating if the GDPR legislation applies: 0: GDPR does not apply. The ad call does not come from EU territory. 1: GDPR applies.The ad call comes from EU territory. |
| Header Bidding Type | headerBiddingTypeName | HeaderBiddingTypeName | m, p, s | The type name of the header bidding mechanism: 0: No Header Bidding 1: Client Side Header Bidding 2: Server Side Header Bidding This dimension is computed as follows: IF IsHeaderBidding = True AND IsServerSideBidding = False THEN 1 ELSE IF IsHeaderBidding = True AND IsServerSideBidding = True THEN 2 ELSE 0. |
| Header Bidding Type | headerBiddingTypeId | HeaderBiddingTypeId | m, p, s | The type Id of the header bidding mechanism: 0: No Header Bidding 1: Client Side Header Bidding 2: Server Side Header Bidding This dimension is computed as follows: IF IsHeaderBidding = True AND IsServerSideBidding = False THEN 1 ELSE IF IsHeaderBidding = True AND IsServerSideBidding = True THEN 2 ELSE 0. |
| Hyper Local | localAreaName | LocalAreaName | p | The name of a hyperlocal area, corresponding to a circle defined by latitude, longitude, and radius. |
| Hyper Local | localAreaId | LocalAreaId | p | The Id of a hyperlocal area, corresponding to a circle defined by latitude, longitude, and radius. |
| Identity Provider | firstParentIdentityProviderId | FirstParentIdentityProviderId | p | The Id of the identity provider, for example: 41: Utiq 5: ID5. |
| Identity Provider | firstParentIdentityProviderName | FirstParentIdentityProviderName | p | The name of the identity provider, for example: 41: Utiq 5: ID5. |
| Identity Provider - Targeted Deal | FirstChildIdentityProviderId | FirstIdentityProviderId | p | The Id of the identity provider targeted in a deal, for example: 41: Utiq 5: ID5. |
| Identity Provider - Targeted Deal | FirstChildIdentityProviderName | FirstIdentityProviderName | p | The name of the identity provider targeted in a deal, for example: 41: Utiq 5: ID5. |
| Is Rewarded | isRewarded | IsRewarded | c, m, p | A boolean indicating if the user is rewarded after viewing an ad, for example: free access to content, a bonus in a game, or a free music session. |
| Is Skippable | videoSkipId | VideoSkippabilityId | c, m, p | The Id of the skippability of the video. -1: Unknown 0: No 1: Yes |
| Is Skippable | videoSkipName | VideoSkippabilityName | c, m, p | The name of the skippability of the video. -1: Unknown 0: No 1: Yes |
| Line Item | lineItemId | LineItemId | m, s3 | The Id of the line item, as configured in the Activation module. |
| Line Item | lineItemName | LineItemName | m, s3 | The name of the line item, as configured in the Activation module. |
| Max Ad Duration | maxVideoDurationBucketId | MaxVideoDurationBucketId | c, p | The bucket Id of the maximum video ad duration, expressed in the following buckets: 0: N/A 1: short (0 - 15 seconds) 2: medium (16 - 30 seconds) 3: long (31 seconds to 60 seconds) 4: extra_long (61 seconds and longer) |
| Max Ad Duration | maxVideoDurationBucketName | MaxVideoDurationBucketName | c, p | The bucket name of the maximum video ad duration, expressed in the following buckets: 0: N/A 1: short (0 - 15 seconds) 2: medium (16 - 30 seconds) 3: long (31 seconds to 60 seconds) 4: extra_long (61 seconds and longer) |
| Partner | partnerId | PartnerId | c, m, p, s | The Id of the demand partner receiving and bidding on bid requests. |
| Partner | partnerName | PartnerName | c, m, p, s | The name of the demand partner receiving and bidding on bid requests. |
| Platform Store | platformStoreId | PlatformStoreId | m, p | The store Id of the connected TV platform. 0: Unknown 1: IOS 2: Android 3: Roku 4: Amazon 5: Microsoft 6: SamsungSmartTV 7: LGSmartTV 8: SonyPlaystation 9: Vizio 10: PhilipsSmartTV |
| Platform Store | platformStoreName | PlatformStoreName | m, p | The store name of the connected TV platform. 0: Unknown 1: IOS 2: Android 3: Roku 4: Amazon 5: Microsoft 6: SamsungSmartTV 7: LGSmartTV 8: SonyPlaystation 9: Vizio 10: PhilipsSmartTV |
| Position in Ad Break | positionInAdBreak | PositionInAdBreakId | m, p | The position of a video ad in an ad break. |
| Publisher | publisherId | NetworkId | c, p, s, s3 | The Id of the publisher's network. |
| Publisher | publisherName | NetworkName | c, p, s, s3 | The name of the publisher's network. |
| Seat | seatId | InternalBuyerSeatId | c, p, s | A dimension indicating video content that is broadcast in real time. -1: unknown 0: No 1: Yes |
| Seat | externalSeatId | ExternalBuyerSeatId | c, p, s | The Id of the external buyer seat, used across Equativ's platforms. |
| Seat | seatName | BuyerSeatName | c, p, s | The name of the external buyer seat, used across Equativ's platforms. |
| Server-Side Bidding Caller | serverSideBiddingCallerId | ServerSideBiddingCallerId | m, p, s | The Id of the caller that is calling Equativ in the server side bidding context. |
| Server-Side Bidding Caller | serverSideBiddingCallerName | ServerSideBiddingCallerName | m, p, s | The name of the caller that is calling Equativ in the server side bidding context. |
| Targeted Audience Provider | targetedAudienceSegmentProviderId | TargetedAudienceSegmentProviderId | s | The provider Id of the audience segment that matched with an audience segment targeted by a deal.² |
| Targeted Audience Provider | targetedAudienceSegmentProviderName | TargetedAudienceSegmentProviderName | s | The provider name of the audience segment that matched with an audience segment targeted by a deal.² |
| Targeted Audience Segment | targetedAudienceSegmentId | TargetedAudienceSegmentId | s | The Id of the audience segment that matched with an audience segment targeted by a deal.² |
| Targeted Audience Segment | targetedAudienceSegmentName | TargetedAudienceSegmentName | s | The name of the audience segment that matched with an audience segment targeted by a deal.² |
| Targeted Deal | externalChildDealId | ExternalChildDealId | c, p, s | The external ID of the deal (with its settings) that is targeted by another deal. |
| Targeted Deal | childDealId | InternalChildDealId | c, p, s | The Equativ internal ID of the deal (with its settings) that is targeted by another deal. |
| Targeted Deal | childDealName | ChildDealName | c, p, s | The name of the deal (with its settings) that is targeted by another deal. |
| Targeted Semantic Provider | targetedSemanticSegmentProviderId | TargetedSemanticSegmentProviderId | s | The provider Id of the semantic segment that matched with a semantic segment targeted by a deal.² |
| Targeted Semantic Provider | targetedSemanticSegmentProviderName | TargetedSemanticSegmentProviderName | s | The provider name of the semantic segment that matched with a semantic segment targeted by a deal.² |
| Targeted Semantic Segment | targetedSemanticSegmentId | TargetedSemanticSegmentId | s | The Id of the semantic segment that matched with a semantic segment targeted by a deal.² |
| Targeted Semantic Segment | targetedSemanticSegmentName | TargetedSemanticSegmentName | s | The name of the semantic segment that matched with a semantic segment targeted by a deal.² |
| Template | templateVersionId | s | The version Id of the creative template used by publishers in the Equativ Monetization Platform. Creative templates determine the way a creative is displayed, for example, as an interstitial or parallax. | |
| Template | templateName | s | The name of the creative template used by publishers in the Equativ Monetization Platform. Creative templates determine the way a creative is displayed, for example, as an interstitial or parallax. | |
| Time | day | DayUtc | c, p, s, s3 | The day dimension. |
| Time | hour | HourUtc | c, p, s, s3 | The hour dimension. |
| Time | week | WeekUtc | c, p, s, s3 | The week dimension. |
| Time | month | MonthUtc | c, p, s, s3 | The month dimension. |
| Video Placement Type | videoPlacementTypeId | InputVideoPlacementTypeId | m, p, s | The Id of the video placement type, according to the legacy IAB taxonomy, sent in the bid request: Default value: 0 or Unknown. 1: Instream 2: In-Banner 3: In-Article 4: In-Feed 5: Interstitial/Floating See VideoPlacementTypeName for more details. |
| Video Placement Type | videoPlacementTypeName | InputVideoPlacementTypeName | m, p, s | The name of the video placement type, according to the legacy IAB taxonomy, sent in the bid request: Default value: 0 or Unknown. In-Stream: played before, during, or after the streaming video content that the consumer has requested (pre-roll, mid-roll, post-roll). In-Banner: exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. In-Article: loads and plays dynamically between paragraphs of editorial content, as a standalone branded message. In-Feed: found in content, social, or product feeds. Interstitial/Slider/Floating: covers the entire or a portion of the screen area, and is always on screen while displayed, meaning it cannot be scrolled out of view. |
| Video Player | videoPlayerWidth | VideoPlayerWidth | c, p, s | The width of the video player. |
| Video Player | videoPlayerHeight | VideoPlayerHeight | c, p, s | The height of the video player. |
| Video Player Size Bucket | videoPlayerSizeBucketId | VideoPlayerSizeBucketId | c, p, s | The Id of the static video player size, grouped into buckets: 1: NoSize; both player width and player height equal to or less than 0. 2: NotCategorized; width between 1 and 49 or height between 1 and 29 as well as any other sizes that don't match with the buckets Small, Large or Extra Large. 3: Small; desktop: less than 400x225; mobile: less than 20% of screen covered. 4: Large; desktop: between 400x225 and 1280x720; mobile: between 21% and 90% of screen covered. 5: ExtraLarge; desktop: greater than 1280x720; mobile: more than 91% of screen covered. |
| Video Player Size Bucket | videoPlayerSizeBucketName | VideoPlayerSizeBucketName | c, p, s | The name of the static video player size, grouped into buckets: 1: NoSize; both player width and player height equal to or less than 0. 2: NotCategorized; width between 1 and 49 or height between 1 and 29 as well as any other sizes that do not match with the buckets Small, Large or Extra Large. 3: Small; desktop: less than 400x225; mobile: less than 20% of screen covered. 4: Large; desktop: between 400x225 and 1280x720; mobile: between 21% and 90% of screen covered. 5: ExtraLarge; desktop: greater than 1280x720; mobile: more than 91% of screen covered. |
| Winner Deal Type | winnerDealTypeId | DealTypeId | m, p, s | The type Id of the deal that won an auction: 0: OpenAuction (no deal) 1: PrivateAuction 2: DirectDeal 3: ProgrammaticGuaranteed 4: AuctionPackage |
| Winner Deal Type | winnerDealTypeName | DealTypeName | m, p, s | The type name of the deal that won an auction: 0: OpenAuction (no deal) 1: PrivateAuction 2: DirectDeal 3: ProgrammaticGuaranteed 4: AuctionPackage |
¹ The "Billed …" dimensions represent segments that are billed by Equativ. If multiple segments from the same provider are targeted, the fee for only the single most expensive segment will be billed. If segments from multiple providers are targeted, the fee for the single most expensive segment per provider will be summed to calculate the total billable fee. For more information, see Audience targeting and Semantic and performance targeting articles. Note that segments without any fee (free segments, Total cost: 0) aren't included in this dimension. To report on free segments, use the "Targeted …" dimensions.
² The "Targeted …" dimensions represent the segments that matched with a segment targeted in a deal, and therefore, resulted in the delivery of the deal. In case of a deal targeting multiple audience/semantic segments, there can be more than one matching audience/semantic segment that resulted in the delivery of the deal. For example, if a deal targets audience segments A, B, and C, and if it was delivered to a user belonging to segment A and B, then this deal will be included in the Targeted Audience Segment A and B.