MUmuxinc
Annotations

List Annotations

Changed on

Returns a list of annotations.

get/data/v1/annotations

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

limitinteger

Number of items to include in the response

pageinteger

Offset by this many pages, of the size of limit

order_direction'asc' | 'desc'

Sort order.

timeframestring[]

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).

Accepted formats are...

  • array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
  • duration string e.g. timeframe[]=24:hours or timeframe[]=7:days

Response

OK

total_row_countinteger required

Total number of annotations available

timeframeinteger[]

Start and end unix timestamps for the data range

Changes