Web API
Start typing to search…

List System Annotations

get https://{account}.piwik.pro/api/analytics/v1/manage/annotation/system/

Returns a list all System Annotations available for a website.
Please note that each request must be authenticated.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Query Params
date_from
array of dates

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.

date_from
date_to
array of dates

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.

date_to
integer
1 to 100000
Defaults to 10

Number of rows to return.

integer
≥ 0
Defaults to 0

Number of rows to skip before beginning to return rows.

Responses

Response body
object
meta
object
required
integer
required

Total number of results.

data
array of objects
required
data*
object
string
required

Type of the object.

SystemAnnotation

uuid
required

ID of a annotation.

attributes
object
required
400

Bad Request

403

Forbidden

Updated 7 days ago

Did this page help you?
Language
Credentials
OAuth2
URL

Updated 7 days ago

Did this page help you?