Contents

TimeRange

Date range, time zone, and granularity settings for reporting requests.

Declaration

object TimeRange

Properties

NameTypeDescription
startdate

The start date in YYYY-MM-DD format. The range is inclusive of this date.

enddate

The end date in YYYY-MM-DD format. The range is inclusive of this date.

timeZonestring

The time zone for the report date range. The default is ORTZ (org timezone). Both ORTZ and UTC are supported for all reports except search term-level, which only supports ORTZ.

granularitystring

Time period breakdown for granularMetrics in the response. When specified, the response includes granularMetrics broken down by this period. Possible values: HOURLY, DAILY, WEEKLY, MONTHLY. HOURLY granularity is not supported for ad-level or search term-level reports.

Discussion

The TimeRange defines the date window, timezone, and optional time-series breakdown for a reporting request.

Example

{
  "start": "2025-01-01",
  "end": "2025-01-10",
  "timeZone": "ORTZ",
  "granularity": "DAILY"
}

See Also