Vionlabs Docs
API Specs

Vionlabs Binge Markers Results API

External docs:SwaggerReDoc

Get marker information for an asset.

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

DEPRECATED.

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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 list of binge markers information

Deprecated
GET
/results/markers/v1/

DEPRECATED.

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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 marker result status and information for an asset.

GET
/results/markers/v2/{ident}

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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 marker result status for an asset.

GET
/results/markers/v2/status/{ident}

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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 paginated list of marker results statuses and information

GET
/results/markers/v2/

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

Authorization

AuthorizationBearer <token>

Stytch access token authentication. Requires BOTH:

  • Authorization: Bearer ACCESS_TOKEN
  • catalog query parameter

Example: Authorization: Bearer ACCESS_TOKEN ?catalog=my_catalog

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"
    }
  ]
}

Vionlabs Tasks API

Vionlabs API for creating, retrieving and deactivating processing tasks for catalog assets and product versions. Tasks are used to orchestrate processing and expose the current state of requested work across the system.

Vionlabs Fingerprint+ API

Vionlabs API for retrieval of content fingerprint results plus additional metadata.