PIpiwik
Analytics

List user annotations

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

get/api/analytics/v1/manage/annotation/user/

Request

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

Example response

{
  "meta": {
    "total": 1
  },
  "data": [
    {
      "id": "677fe0d3-b4f7-43ed-852d-1a9e7b8e59fb",
      "attributes": {
        "date": "2021-05-01",
        "content": "Launch of a new campaign!"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.