Vionlabs Docs

Vionlabs Marker Results API

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

Get marker information for an asset.

Returns asset marker information for the asset with the specified customer ident. If the asset is found in catalog but has not yet been processed the not_yet_available flag will be set in the response

GET
/results/markers/v1/asset/{ident}
key<token>

In: query

Path Parameters

identIdent

Customer identifier for an item in the catalog

Query Parameters

version?Version

Specify binge markers version code

Response Body

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

Get list of binge markers information

Returns paginated list of items with binge markers information for the customer catalog

GET
/results/markers/v1/
key<token>

In: query

Query Parameters

from_utcdatetime?From Utcdatetime

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

Formatdate-time
to_utcdatetime?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

Formatdate-time
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?Version

Specify binge markers version code

Response Body

curl -X GET "https://loading/results/markers/v1/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=1000&version=string"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": []
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get marker result status and information for an asset.

Gets asset marker result status and information for the asset with the specified customer ident.

GET
/results/markers/v2/{ident}
key<token>

In: query

Path Parameters

identIdent

Customer identifier for an item in the catalog

Query Parameters

version?Version

Specify binge markers version code

Response Body

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

Get paginated list of marker results statuses and information

Returns paginated list of items with binge markers information for the customer catalog

GET
/results/markers/v2/
key<token>

In: query

Query Parameters

from_utcdatetime?From Utcdatetime

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

Formatdate-time
to_utcdatetime?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

Formatdate-time
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?Version

Specify binge markers version code

Response Body

curl -X GET "https://loading/results/markers/v2/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=500&version=string"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": []
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}