Annotations

List annotations

Returns a list of annotations that your account has access to. Annotations are listed in reverse chronological order by default.

get/analytics/v1/annotations

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/analytics/v1/annotations
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Query parameters

maxResultsstring

The maximum number of results to return in a single page. Use the page tokens to iterate through the entire collection.

pageTokenstring

Page token, returned by a previous call, to request the next page of results

filterstring

An expression for filtering the results. Valid fields: content, timestamp, labels.

sortBy'id' | 'content' | 'timestamp' | 'timeCreated' | 'timeModified'

A field by which the results will be sorted.

sortOrder'asc' | 'desc'

Sort order can be ascending or descending.

Response

OK - The request succeeded.

pageTokenstring

Page token, returned by a previous call, to request the next page of results

rowCountinteger

Total number of annotations in the result set

Changes

No recorded changes to this operation across all 1 revision of this API.