Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Dimension

API Representation

Notes

Publisher Name

publisher_name

 Name of the publisher

Site

site_name

Collection of placements that often correspond to a website or application. Example: "Cats.com"

Primary Domain

primary_domain

The primary domain associated with the incoming web request.

Notable Domain

notable_domain

The notable domain associated with the incoming web request. Example: “www.cats.com

Country

country

 Two or three letter code abbreviation for the country. Example: "US"

Placement Name

placement_name

 Name given to the placement or ad slot.

Placement Key

placement_key

 Integration key associated with incoming request.  Example: "bQRKnWWz6KnFqsGmttQmCoGP"

Device Type

device_type

 Possible values for filtering are:

  • "Connected Device"

  • "Connected TV"

  • "Mobile/Tablet"

  • “Personal Computer"

  • "Phone"

  • “Set Top Box”

  • “Tablet”

Date

date

Date which the impression was first requested.  Example: "2020-08-10"

Hour

hour

Hour an impression was requested. Possible values 1-24.

Supply Integration

supply_name

The name of the supply integration path to filter by. There are many possible values to supply as filters for this property. Below is a partial list of examples:

  • "Google OB"

  • "Index Exchange"

  • "Microsoft"

  • "Prebid Client-side"

  • "Prebid Server"

  • "Tag on Page"

  • "Verizon"

Type 

site_type

The type of the site (i.e. app or web). Possible values are

  • “AppProperty”

  • “WebProperty”

App Bundle ID

bundle_id

The bundle ID for a given app. This is a string whose format varies across providers (e.g. “com.something.else” for Android, “1234567” for iOS, etc.)

OS Type 

os_type

The operating system of the user, as determined by user agent. Possible values are

  • “Android”

  • “Chrome OS”

  • “MacOS”

  • “Windows”

  • “iPadOS”

  • “iPhoneOS”

Placement Size

placement_size

Size of the placement when set up by STR (display only placements)

Adelaide AU Group

adelaide_au_group

Attention Score provided by Adelaide that can take the values of “High”, “Medium”, or “Low”. Note: not available when cpm or dsp_name are included as fields in the request payload.

Adverifai Score Bucket

adverifai_score_bucket

Use this field to break out results by Adverifai’s score bucket. Score buckets are basically score ranges that increment by 0.05 and go from 0 to 1. So, for example, one site might have a score of 0.15, while another might be 0.22. These two entries would be broken out into separate buckets.

Fields

The table below describes the header bidding metrics that can be accessed through the API: At least one field is required in the request:

...