Contents

ImpressionShareQueryRequest

Request body for the impression share query endpoint.

Declaration

object ImpressionShareQueryRequest

Properties

NameTypeDescription
filters Required[Filter]

Filter conditions. A filter on promotedObjectId is required. Omitting it will result in a 400 error.

sorting[Sorting]

Sort criteria. Maximum 2 sort fields.

timeRange RequiredImpressionShareTimeRange

Specifies the date window to query. Timezone is fixed to UTC. See ImpressionShareTimeRange for details.

paginationRequestPagination

Pagination controls. Default pageSize is 100. Maximum pageSize is 10000. See RequestPagination for details.

optionsImpressionShareOptions

Allows additional configuration of the impression share calculation. See ImpressionShareOptions for details.

Example

{
  "fields": [],
  "filters": [
    {
      "field": "promotedObjectId",
      "operator": "EQUALS",
      "value": "123456789"
    },
    {
      "field": "countryOrRegion",
      "operator": "EQUALS",
      "value": "US"
    }
  ],
  "sorting": [
    {
      "field": "highImpressionShare",
      "order": "DESC"
    }
  ],
  "timeRange": {
    "start": "2025-01-01",
    "end": "2025-01-07",
    "timeZone": "UTC",
    "granularity": "DAILY"
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20
  },
  "options": {
    "impressionShareReportType": "FIRST_SLOT"
  }
}

See Also