Analytics

Get user annotation

Returns a definition of a specific user annotation. Please note that each request must be authenticated.

get/api/analytics/v1/manage/annotation/user/{id}/

Request

Base URL
https://example.piwik.pro
Auth
OAuth 2
Client credentials
Token URL/auth/token
TypeScript
https://skmtc.dev/piwik/apis/web-api/docs/api/analytics/v1/manage/annotation/user/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the object.

Query parameters

website_idstring uuid required

ID of the website.

Response

Example response

{
  "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.