Sign in

v1

latestOpenAPI 3.1.02026-07-2419603.1 MB
Analytics

List System Annotations

Returns system annotations for the organization. Query parameter website_id is required: it selects the website for access-control (view permission) and filters results to annotations for that website plus annotations not scoped to a single website. Please note that each request must be authenticated.

get/api/analytics/v1/manage/annotation/system/

Query parameters

website_idstring uuid required

ID of the website.

date_fromstring[]

Start date for the query (inclusive). You can specify mulitple dates which will be paired with corresponding date_to parameters. For example ?date_from=2020-01-01&date_to=2020-01-10&date_from=2021-06-01&date_to=2021-07-01 will create two ranges: [2020-01-01; 2020-01-10] and [2021-06-01; 2021-07-01]. Number of date_from parameters must match number of date_to parameters.

[
  "2021-05-01"
]
date_tostring[]

End date for the query (inclusive). You can specify mulitple dates which will be paired with corresponding date_to parameters. Read more in date_from parameter description.

[
  "2021-05-01"
]
limitinteger

Number of rows to return.

offsetinteger

Number of rows to skip before beginning to return rows.

Response

OK