Vionlabs Docs

Vionlabs Marker Results API

External docs:SwaggerReDoc

Vionlabs API for retrieval of marker results (intro/recap skip and end credit detection).

GET
/results/markers/v1/asset/{ident}

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

ident*Ident

Customer identifier for an item in the catalog

Query Parameters

version?|

Specify binge markers version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/markers/v1/asset/string"
{
  "credit_start": 3057,
  "ident": "1347gg5",
  "intro_end": 125,
  "intro_start": 60,
  "not_yet_available": false,
  "recap_end": 155,
  "recap_start": 125
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/results/markers/v1/

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Query Parameters

from_utcdatetime?|

Specifies start of time window (ISO 8601). If not specified then all results will be returned

to_utcdatetime?|

Specifies end of time window (ISO 8601). If not specified then utcnow() value will be used.It is recommended to fix this argument while looping across pages to establish a fixed time window

page_num?Page Num

Specifies a positional number of page with results

Default0
Range0 <= value
page_size?Page Size

Specifies a max number of results per page

Default1000
Range1 <= value
version?|

Specify binge markers version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/markers/v1/"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": []
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/results/markers/v2/{ident}

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

ident*Ident

Customer identifier for an item in the catalog

Query Parameters

version?|

Specify binge markers version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/markers/v2/string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "credit_start": 3057,
    "ident": "1347gg5",
    "intro_end": 125,
    "intro_start": 60,
    "not_yet_available": false,
    "recap_end": 155,
    "recap_start": 125
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/results/markers/v2/status/{ident}

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Path Parameters

ident*Ident

Customer identifier for an item in the catalog

Query Parameters

version?|

Specify binge markers version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/markers/v2/status/string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
GET
/results/markers/v2/

Authorization

X-API-Key<token>

[DEPRECATED] API key authentication using the X-API-Key HTTP header. Use the 'key' query parameter (?key=YOUR_API_KEY) instead.

In: header

Query Parameters

from_utcdatetime?|

Specifies start of time window (ISO 8601). If not specified then all results will be returned

to_utcdatetime?|

Specifies end of time window (ISO 8601). If not specified then utcnow() value will be used.It is recommended to fix this argument while looping across pages to establish a fixed time window

page_num?Page Num

Specifies a positional number of page with results

Default0
Range0 <= value
page_size?Page Size

Specifies a max number of results per page

Default500
Range1 <= value
version?|

Specify binge markers version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/markers/v2/"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": []
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}