Sign in
General.Calendar
ENTERPRISE

Query Period details

Get a list of detailed periods from a given start period to an end period. Will always return one of the monthly resolutions.

get/api/v1/calendar/periods

Query parameters

period_gte'YYYY-MM-DD' required

Date inside the start period. No greater than 10 years.

period_lte'YYYY-MM-DD' required

Date inside the end period. No later than 10 years.

Response

The periods were successfully returned.

endDateinteger

Timestamp at the end of the period

namestring
resolution'MONTHLY' | 'MONTHLY_ADJUSTED'

Resolution for the statistics.

startDateinteger

Timestamp at the start of the period

Example response

[
  {
    "endDate": 1464739199000,
    "name": "2016-05",
    "resolution": "MONTHLY",
    "startDate": 1462060800000
  }
]

Changes

No recorded changes to this endpoint across all 10 revisions of this API.