Skip to main content
GET
/
annotations
/
annotations
/
v1
cURL
curl --request GET \
  --url https://api.mottostreaming.com/annotations/annotations/v1 \
  --header 'Authorization: Bearer <token>'
{
  "annotations": [
    {
      "project_id": "<string>",
      "type_id": "<string>",
      "video_id": "<string>",
      "offset": "<string>",
      "id": "<string>",
      "visibility": "VISIBILITY_UNSPECIFIED",
      "event_id": "<string>",
      "creative_work_id": "<string>",
      "entity_ids": [
        "<string>"
      ],
      "action_overrides": {},
      "start_offset": "<string>",
      "end_offset": "<string>",
      "source_type": "SOURCE_TYPE_UNSPECIFIED",
      "source_id": "<string>",
      "confidence": 123,
      "timer_label": "<string>",
      "order": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page_size
integer<int32>

Maximum number of records to return

​
project_id
string
​
filter
string

Filter the result-set by properties using a subset of the Kibana Query Language. Only AND statements are supported. E.g. video_id:49fjdSRE3ma9 and type_id:goal Important: When providing a filter, the video_id property is required.

​
order_by
string

Specifies the result ordering for List requests. Supported values are:

  • "offset asc|desc"
  • "order asc|desc"
​
page_token
string

The pagination token in the List request.

Response

OK

​
annotations
object[]
​
next_page_token
string

The pagination token that should be used to get next page results. An empty value means no more results