Contents

CustomReportRequest

The Impression Share report request body.

Declaration

object CustomReportRequest

Properties

NameTypeDescription
dateRangestring

The date range of the report request. A date range is required only when using WEEKLY granularity in Impression Share Report.

endTimestring

The end time of the report. The format is YYYY-MM-DD, such as 2024-06-30.

granularitystring

The report data organized by day or week.

Impression Share reports with a WEEKLY granularity value can’t have custom startTime and endTime in the request payload.

name Requiredstring

A free-text field. The maximum length is 50 characters.

selectorCustomReportRequest.Selector

Selector is an optional parameter to filter API results using the CountryOrRegion and adamId fields. For CountryOrRegion, use an alpha-2 country code value. The IN operator is available to use with Impression Share reports.

See SovCondition for Selector descriptions and see Selector for structural guidance with selectors.

{
  "name": "impression_share_API_report_example",
  "granularity": "DAILY",
  "startTime": "2024-01-11",
  "endTime": "2024-02-08",
  "selector": {
    "conditions": [
      {
        "field": "adamId",
        "operator": "IN",
        "values": [
          1252497129,
          282614216
        ]
      },
      {
        "field": "countryOrRegion",
        "operator": "IN",
        "values": [
          "US",
          "CA"
        ]
      }
    ]
  }
}
startTimestring

The start time of the report. The format is YYYY-MM-DD, such as 2024-06-01.

Discussion

See also Impression Share Report, Get a Single Impression Share Report, Get All Impression Share Reports, and CustomReportResponse.

Topics

Objects

See Also

Impression Share Report Request and Response Objects