|
Relative endpoint |
HTTP method |
Request Content type |
Response Content type |
Minimum permission required |
Device permission override |
Pagination |
|---|---|---|---|---|---|---|
|
api/reporting/reporting-periods |
GET |
json |
json |
None |
No |
No |
This endpoint returns a fixed set of reporting period configurations as described under “Standard Periods” section of Analytics Reporting Periods Terminology
The endpoint returns a list of JSON objects with period configuration details.
The keys of a PeriodConfiguration object are detailed below:
|
Key |
Description |
Examples |
|---|---|---|
|
period_index |
the index of the current |
|
|
period_name |
a descriptive name for the |
|
|
period_duration |
a name for the |
|
|
period_unit |
a parameter, as defined in - Analytics Reporting Periods Terminology |
|
|
group_size |
a parameter, as defined in - Analytics Reporting Periods Terminology |
|
|
number_of_groups |
a parameter, as defined in - Analytics Reporting Periods Terminology |
|
|
is_default |
determines whether this |
|
[
{period_index: 0, period_name: "Last 14 days", period_duration: "Last 14 days", period_unit: "day",…}
{period_index: 1, period_name: "Last 3 months by week", period_duration: "Last 3 months",…}
{period_index: 2, period_name: "Last 12 months", period_duration: "Last 12 months",…}
{period_index: 3, period_name: "Last 3 years by quarter", period_duration: "Last 3 years",…}
{period_index: 4, period_name: "Last 5 years", period_duration: "Last 5 years", period_unit: "year",…}
]