Contact support
    • Monetization
    • Developer documentation
    • Automate monetization
    • Automate reporting (API)

    Reporting API: dimension reference

    Table of Contents

    Overview Dimension reference

    Overview

    This document lists the dimensions supported by the reporting API of Equativ's Monetization platform. 

    Dimension reference

    In the following table, each row contains the Dimension name, Dimension use case, and the Dimension definition. For more information about use cases, see Reporting API: get started.

    Dimension name Dimension use case* Dimension definition
    AdBreakTypeId a, h, r 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
    AdBreakTypeName a, h, r 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
    AddConsentStringStatusId h, r The Id of the additional consent string status, as specified by Google's Additional Consent framework. This framework is used for vendors that are not registered as an IAB Europe TCF vendor, but that are registered as a Google Ad Tech Provider.
    -1: Malformed
    0: No consent string
    1: Has VALID consent string
    AddConsentStringStatusName h, r The Id of the additional consent string status, as specified by Google's Additional Consent framework. This framework is used for vendors that are not registered as an IAB Europe TCF vendor, but that are registered as a Google Ad Tech Provider.
    -1: Malformed
    0: No consent string
    1: Has VALID consent string
    AddConsentStringVersionId h, r The Id of the additional consent string version, as specified by Google's Additional Consent framework. This framework is used for vendors that are not registered as an IAB Europe TCF vendor, but that are registered as a Google Ad Tech Provider.
    AdId h, r A unique ad Id sent for each served programmatic ad markup. It isn't related to the ad being served, but to the ad request itself.
    AdPositionName h, r The name of the ad position:
    atf: above the fold
    btf: below the fold
    mtf: middle of the page
    AdservingCreativeEndDate a, h The end date of the creative in a direct insertion.
    AdservingCreativeExternalDescription a, h The external description of the creative in a direct insertion.
    AdservingCreativeFileName a, h The file name of the creative in a direct insertion.
    AdservingCreativeHeight a, h The height of the creative in a direct insertion.
    AdservingCreativeId a, h The Id of the creative in a direct insertion.
    AdservingCreativeName a, h The name of the creative in a direct insertion.
    AdservingCreativeStartDate a, h The start date of the creative in a direct insertion.
    AdservingCreativeWeight a, h The weight of the creative in a direct insertion.
    AdservingCreativeWidth a, h The width of the creative in a direct insertion.
    AdvertiserDomain h, r The domain name associated with a programmatic advertiser, used to identify, categorize, and track ads.
    AdvertiserDomainCategoryId h, r The Id of the category an RTB advertiser's domain falls into.
    AdvertiserDomainCategoryName h, r The name of the category an RTB advertiser's domain falls into.
    AdvertiserDomainId h, r The Id of a programmatic advertiser domain.
    AdvertiserId a, h, r The Id of the advertiser purchasing the impression.
    AdvertiserName a, h, r The name of the advertiser purchasing the impression.
    AdvertiserSalesPersonFirstName a, h, r The first name of the sales representative responsible for the advertiser.
    AdvertiserSalesPersonLastName a, h, r The last name of the sales representative responsible for the advertiser.
    AdvertiserSalesPersonName a, h, r The complete name of the sales representative responsible for the advertiser.
    AdvertiserTrafficManagerFirstName a, h, r The first name of the traffic manager responsible for the advertiser.
    AdvertiserTrafficManagerLastName a, h, r The last name of the traffic manager responsible for the advertiser.
    AdvertiserTrafficManagerName a, h, r The complete name of the traffic manager responsible for the advertiser.
    AgencyId a, h, r The unique identifier assigned to a media agency within Equativ's platform.
    AgencyName a, h, r The unique name assigned to a media agency within Equativ's platform.
    AllowedToUseGeolocationData a, h, r A boolean indicating if consent to use geolocation data was given or withheld by the end user under the GPP/GDPR/CCPA frameworks.
    AllowedToUsePersonalData a, h, r A boolean indicating if consent to use personal data was given or withheld by the end user under the GPP/GDPR/CCPA frameworks.
    AppSiteChannelContentCategories a, h, r The category of the content of the site, app, or TV channel, as defined under Inventory > Sites & Pages.
    AppSiteChannelUrl a, h, r The URL of the content of the site, app, or TV channel, as defined under Inventory > Sites & Pages.
    AttStatus a, h, r The authorization status to access app related data, as specified by Apple's App Tracking Transparency (ATT) framework:
    -1: ATT Not Supported (for older SDKs that don't recognize ATT)
    0: Not Determined
    1: Restricted
    2: Denied
    3: Authorized
    AttStatusName a, h, r The authorization status name to access app related data, as specified by Apple's App Tracking Transparency (ATT) framework:
    -1: ATT Not Supported (for older SDKs that don't recognize ATT)
    0: Not Determined
    1: Restricted
    2: Denied
    3: Authorized
    AudienceSegmentName s The name of the audience segment used for targeting, typically defined by a Data Management Platform (DMP) or a third-party data provider.
    AudienceSegmentProviderId s The Id of the audience segment provider.
    AudienceSegmentProviderName s The name of the audience segment provider.
    BidStatusId h, r The status Id of a bid in the auction process, used for troubleshooting. This dimension works with specific, bid related metrics only, for example, the Bids metric.
    0: None
    1: Loss
    2: Win etc.
    BidStatusName h, r The status name of bids in the auction process, used for troubleshooting. This dimension works with specific, bid related metrics only, for example, the Bids metric.
    0: None
    1: Loss
    2: Win etc.
    BrowserId a, h, r The end user's browser Id that calls an ad from Equativ.
    BrowserName a, h, r The end user's browser name that calls an ad from Equativ.
    CampaignId a, h, r The Id of the campaign.
    CampaignName a, h, r The name of the campaign.
    CampaignSalesPersonId a, h, r The sales person responsible for the campaign, as defined in the campaign setup.
    CampaignTrafficManagerId a, h, r The traffic manager responsible for the campaign, as defined in the campaign setup.
    CityId a, h, r The Id of the city where an ad opportunity occurs.
    CityName a, h, r The name of the city where an ad opportunity occurs.
    CmpId a, h, r The Id of the Consent Management Platform (CMP) used to retrieve the end users consent to data processing, in compliance with privacy regulations.
    ConsentStringStatusId a, h, r The status Id of the IAB Europe TCF consent string.
    -1: N/A (malformed or invalid)
    0: Empty
    1: OK
    2: Fallback consent connected TV
    ConsentStringStatusName a, h, r The status name of the IAB Europe TCF consent string.
    -1: N/A (malformed or invalid)
    0: Empty
    1: OK
    2: Fallback consent connected TV
    ContentContext h, r The context of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentDistributorId a, h, r The Id of the distributor of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentEpisodeNumberId a, h, r The episode number Id of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentGenre h, r The genre of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentLanguage h, r The language, conforming to ISO-639-1-alpha-2, of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentSeasonNumberId a, h, r The season number Id of the content surrounding the ad, declared by the publisher as part of content metadata.
    ContentSourceId a, h, r A custom Id that a publisher can pass in the ad request representing a sub-domain, blog, channel, page or any other piece of content.
    CountryId a, h, r The country Id of the ad opportunity, following the ISO 3166-1 standard.
    CountryName a, h, r The country name of the ad opportunity, following the ISO 3166-1 standard.
    CreativeId h, r The Id of the programmatic creative.
    CreativeSize h, r The dimensions of the creative in format Width*Height.
    Day a, h, r The Day dimension.
    DeliveryChannel a, h The delivery channel, indicating if the data is related to direct campaigns (direct) or to programmatic monetization (rtb).
    DeviceModelId a, h, r The Id of the device model.
    DeviceModelName a, h, r The name of the device model.
    DeviceTypeId a, h, r 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
    DeviceTypeName a, h, r 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
    DeviceVendorId a, h, r The Id of the device vendor (manufacturer).
    DeviceVendorName a, h, r The name of the device vendor (manufacturer).
    EnvironmentTypeId a, h, r The type Id of the environment.
    0: Web
    1: Mobile Web
    2: App
    EnvironmentTypeName a, h, r The type name of the environment.
    0: Web
    1: Mobile Web
    2: App
    ExtendedIds h, r The extended Ids sent with the ad call. A row in the report containing multiple provider Ids (for example: 4,5) represents the case where extended Ids of multiple providers were sent in the same ad call, for example, Identity Link (4) and ID5 (5).
    ExternalContentId a, h, r The Id of the content surrounding the ad in a third party system, declared by the publisher as part of content metadata.
    ExternalSeatId h, r The Id of the seat in an external system.
    FormatExternalId a, h, r The external Id of the format, as defined under Inventory > Formats.
    FormatHeight a, h, r The height of the format, as defined under Inventory > Formats.
    FormatId a, h, r The Id of the format.
    FormatName a, h, r The name of the format.
    FormatType a, h, r The type of the format, as defined under Inventory > Formats.
    FormatTypeId a, h, r The Id of the impression type.
    0: Banner
    1: VideoInStream
    2: Native
    3: VideoOutStream
    4: Unknown
    5: Audio
    FormatTypeName a, h, r The name of the impression type.
    0: Banner
    1: VideoInStream
    2: Native
    3: VideoOutStream
    4: Unknown
    5: Audio
    FormatWidth a, h, r The width of the format, as defined under Inventory > Formats.
    GdprApplies a, h, r 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.
    HasBuyerUid h, r A boolean indicating if the Buyer Uid is present in the call. This Id is stored on the user's browser by the DSP through a third-party cookie and is shared with Equativ via cookie syncing. This way, Equativ can link its own Pid with the Buyer Uid and send the latter to the DSP when necessary.
    HasKeywordKey a, h, r A filter dimension used to determine if a specific key was present in an ad call. It takes a key as a parameter and returns true if the keyword array contains at least one occurrence of this key.
    HasKeywordKeyValue a, h, r A filter dimension used to determine if a specific key-value pair was present in an ad call. It takes a key and a value as parameters and returns true if the keyword array contains at least one occurrence of this key and this value.
    HasUserPid a, h, r A boolean indicating if Equativ's Pid is sent in the ad call. Pid is Equativ's own proprietary user identifier assigned to each user.
    HasUserUid a, h, r A boolean indicating if the User Uid is sent in the ad call. Uid is a first party user identifier generated by a publisher on the website.
    HeaderBiddingPartnerName a, h The name of the SSP winning the header bidding competition in the context of unified auctions, where the highest bid among Equativ's demand partners is in competition with the highest bid among header bidding SSPs.
    HeaderBiddingTypeId h, r 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.
    HeaderBiddingTypeName h, r 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.
    Hour a, h, r The Hour dimension.
    InsertionCurrencySymbol a, h, r The symbol of the insertion currency, for example, EUR or USD.
    InsertionDescription a, h, r The description of the insertion, as defined in the insertion setup.
    InsertionEndDate a, h, r The end date of the insertion.
    InsertionExternalDescription a, h, r The external description of the insertion, as defined in the insertion setup.
    InsertionExternalId a, h, r The external Id of the insertion, as defined in the insertion setup.
    InsertionFlatFee a, h, r The flat fee amount of the insertion, as defined in the insertion setup.
    InsertionId a, h, r The Id of the insertion.
    InsertionName a, h, r The name of the insertion.
    InsertionPriorityId a, h, r The priority Id of the insertion, for example:
    61: Normal 4
    62: Normal 3
    103: Exclusive 2
    104: Exclusive 1
    InsertionPriorityName a, h, r The priority name of the insertion:
    Very low
    Low
    Normal
    High
    Exclusive
    InsertionStartDate a, h, r The start date of the insertion.
    InsertionTypeId a, h, r The type Id of the insertion, as defined in the insertion setup.
    InsertionTypeName a, h, r The type name of the insertion, as defined in the insertion setup.
    IsAdRefresh h, r A boolean indicating if an ad refresh has occurred.
    IsAmp a, h, r A boolean indicating if the ad call is from an Accelerated Mobile Page (AMP).
    IsAuctionPackages h, r A boolean indicating if the deal is an Auction Package, created on Equativ's Maestro platform.
    IsAutoPromotion a, h, r A boolean indicating if the insertion is set up as an in-house insertion.
    IsLiveEvent a, h, r A boolean indicating if an ad was delivered during a live event, for example during a soccer match.
    IsPageSemanticSegment s A boolean indicating if a given segment is a page-level semantic segment. If true, it can cause duplicate data rows during reporting and impact how metrics, such as impressions, are aggregated.
    IspId a, h, r The Id of the Internet Service Provider.
    IspName a, h, r The name of the Internet Service Provider.
    IsRevenueOpportunity h, r A boolean indicating if the impression was a revenue opportunity, meaning it was eligible for monetization to generate revenue. Examples for it to be false include GDPR restrictions or the fact that no bid request is sent.
    IsRewarded h, r 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.
    KeywordValueList a, h, r A filter used to handle keyword data. It takes a key as a parameter and returns an aggregated string of all the values associated with that particular key. Related filters include HasKeywordKey and HasKeywordKeyValue, used to check for the presence of specific keys or key-value pairs in a dataset.
    Minute a, h, r The time of the auction event, down to the minute.
    Month a, h, r The Month dimension.
    NetworkAudienceSegmentId s The Id of an audience segment at network level. When used, it may duplicate log entries for each associated segment.
    NetworkAudienceSegmentName s The name of an audience segment at network level. When used, it may duplicate log entries for each associated segment.
    NetworkAudienceSegmentProviderId s The provider Id of a network-level audience segment, used to distinguish which data provider supplied the segment for targeting or reporting.
    NetworkAudienceSegmentProviderName s The provider name of a network-level audience segment, used to distinguish which data provider supplied the segment for targeting or reporting.
    NetworkSemanticSegmentId s The Id of a contextual (semantic) segment at network level. When used, it may duplicate log entries for each associated segment.
    NetworkSemanticSegmentName s The Id of a contextual (semantic) segment at network level. When used, it may duplicate log entries for each associated segment.
    NetworkSemanticSegmentProviderId s The provider Id of a network-level semantic segment, used to distinguish which data provider supplied the segment for targeting or reporting.
    NetworkSemanticSegmentProviderName s The provider name of a network-level semantic segment, used to distinguish which data provider supplied the segment for targeting or reporting.
    OsId a, h, r The Id of the end user's operating system.
    OsName a, h, r The name of the end user's operating system family (iOS, Android, Windows etc.).
    OutputBundleId h, r The bundle (app) Id sent in the bid requests to Equativ's demand partners.
    PackId a, h, r The Id of the pack. A pack is a group of sites or pages. If the same impression belongs to multiple packs, it's reported multiple times (one per pack).
    PackName a, h, r The Id of the pack. A pack is a group of websites or pages. If the same impression belongs to multiple packs, it's reported multiple times (one per pack).
    PageContentCategories a, h, r The category of the page content, as defined under Inventory > Sites & Pages.
    PageId a, h, r The Id of the page, as declared under Inventory > Sites & Pages.
    PageName a, h, r The name of the page, as declared under Inventory > Sites & Pages.
    PageUrl a, h, r The URL of the page, as defined under Inventory > Sites & Pages
    PartnerId h, r The Id of the demand partner receiving and bidding on bid requests.
    PartnerName h, r The name of the demand partner receiving and bidding on bid requests.
    PlatformStoreId h, r 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
    PlatformStoreName h, r 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
    PositionInAdBreak a, h, r The position of a video ad in an ad break.
    PostalCode a, h, r The postal code, based on the end user's geolocation.
    PublisherExternalDealId h, r The external Id of a deal, as provided by the network or supply partner. This Id is used to track and reference the deal across systems in a standardized way.
    RevenueSharing h, r The revenue share of the publisher, as defined in the SSP contract between Equativ and the publisher.
    SbcCompanyId r The Id of the Maestro company (formerly "SBC company"), corresponding to a curator buying inventory from Equativ inventory suppliers.
    SbcCompanyName r The name of the Maestro company (formerly "SBC company"), corresponding to a curator buying inventory from Equativ inventory suppliers.
    ScreenHeight a, h, r The height of the end user's screen, in pixels.
    ScreenWidth a, h, r The width of the end user's screen in pixels.
    SdkVersionId a, h, r The Id of the mobile SDK version.
    SdkVersionName a, h, r The version name of the mobile SDK version.
    SeatId h, r The Id of the buyer seat that bids on the bid request.
    SeatName h, r The name of the buyer seat that bids on the bid request.
    SemanticSegmentProviderId s The Id of the semantic segment provider.
    SemanticSegmentProviderName s The name of the semantic segment provider.
    ServerSideBiddingCallerId h, r The Id of the caller that is calling Equativ in the server side bidding context.
    ServerSideBiddingCallerName h, r The name of the caller that is calling Equativ in the server side bidding context.
    StateId a, h, r The Id of the state where an ad opportunity occurs; determined based on the user's IP address.
    StateName a, h, r The name of the state where an ad opportunity occurs; determined based on the user's IP address.
    VideoClientTechnologyId a, h, r The Id of the video client technology, sent by Equativ's video plugin in the ad request, using the parameter vct.
    1: Flash
    2: javascript
    VideoCmsId a, h, r The video content management system of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentCategory a, h, r The category of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentCategory a, h, r The category of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentDurationName a, h, r The duration of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentId a, h, r The Id of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentTags a, h, r The tags that describe the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentTitle a, h, r The title (name) of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoContentType a, h, r The type of the content surrounding the ad, declared by the publisher as part of content metadata.
    VideoErrorCodeId a, h, r The Id of the error code that occurred in a video ad.
    VideoErrorCodeName a, h, r The name (label) of the error code that occurred in a video ad.
    VideoIntegrationTypeId a, h, r The Id of the type of out-stream video/in-stream video integration:
    0: N/A
    1: Instream Plugins
    2: Instream Embedded Ad Manager
    3: Outstream synchronous formats
    4: Outstream asynchronous formats
    VideoIntegrationTypeName a, h, r The name of the type of out-stream video/in-stream video integration:
    0: N/A
    1: Instream Plugins
    2: Instream Embedded Ad Manager
    3: Outstream synchronous formats
    4: Outstream asynchronous formats
    VideoPlacementTypeId h, r

    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.
    VideoPlacementTypeName h, r 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.
    VideoPlaybackMethodId h, r The playback method of the video player, specified with the parameter vpmt in GET ad requests or with the Playback method parameter in the insertion's creative template.
    0: unknown
    1: autoplay with sound on
    2: autoplay with sound off
    3: play on click with sound on
    4: play on mouse-over with sound on
    VideoPlayerHeight h, r The height of the video player.
    VideoPlayerSizeBucketId h, r 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 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.
    VideoPlayerSizeBucketName h, r 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.
    VideoPlayerWidth h, r The width of the video player.
    VideoSkipId h, r The Id of the skippability of the video.
    -1: Unknown
    0: No
    1: Yes
    VideoSkipName h, r The name of the skippability of the video.
    -1: Unknown
    0: No
    1: Yes
    Week a, h, r The Week dimension.
    WinnerDealTypeId h, r The type Id of the deal.
    0: Open Auction
    1: Private Auction
    2: Direct Deal
    3: Programmatic Guaranteed
    4: Auction Package
    WinnerDealTypeName h, r The type name of the deal.
    0: Open Auction
    1: Private Auction
    2: Direct Deal
    3: Programmatic Guaranteed
    4: Auction Package

    * Use cases refer to the context the given dimension is used in:

    • a: adserving (data related to direct (non-programmatic) campaigns/insertions)
    • r: rtb (programmatic data)
    • h: holistic (both direct campaign/insertion data and programmatic data)
    • s: segment (data related to audience segments or semantic segments)

    For more information, see Reporting API: get started.

    RELATED ARTICLES