DateRange

  • Defines a contiguous set of days using startDate and endDate for querying data within a specific timeframe.

  • Allows requests for up to 4 date ranges, providing flexibility in data retrieval.

  • Uses a JSON representation with fields for startDate, endDate, and an optional name for the date range.

  • Accepts date formats in YYYY-MM-DD or relative formats like NdaysAgo, yesterday, or today.

  • Enables assigning custom names to date ranges or uses default naming based on their index in the request.

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

JSON representation 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Fields
startDate

string

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after endDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.
endDate

string

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before startDate. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone.
name

string

Assigns a name to this date range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, date ranges are named by their zero based index in the request: date_range_0, date_range_1, etc.