TimeRange
Date range, time zone, and granularity settings for reporting requests.
Declaration
object TimeRangeProperties
| Name | Type | Description |
|---|---|---|
start | date | The start date in YYYY-MM-DD format. The range is inclusive of this date. |
end | date | The end date in YYYY-MM-DD format. The range is inclusive of this date. |
timeZone | string | 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. |
granularity | string | Time period breakdown for granularMetrics in the response. When specified, the response includes granularMetrics broken down by this period. Possible values: |
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"
}