Vionlabs Docs
API Specs

Vionlabs Ad Breaks API

External docs:SwaggerReDoc

Get item Ad Break result status and data, expressed in seconds

Deprecated
GET
/results/adbreaks/v3/filter/millisec/{inventory_id}

DEPRECATED.

Get the ad breaks result status and data in seconds for an item in 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

Path Parameters

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Ad breaks version code

minimum_separation?Minimum Separation

A number of minutes of minimum separation between Ad Breaks

Default1
maximum_separation?Maximum Separation

A number of minutes of maximum separation between Ad Breaks

Default5
skip_first?Skip First

A number of first minutes to skip checking for an Ad Break presence

Default0
skip_last?Skip Last

A number of last minutes to skip checking for an Ad Break presence

Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/results/adbreaks/v3/filter/millisec/string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "adbreak": [
      {
        "candidates": [
          10.6,
          1352.08,
          1886.6,
          2401.6
        ],
        "rank": 1
      },
      {
        "candidates": [
          1535.4,
          2101.3
        ],
        "rank": 2
      },
      {
        "candidates": [
          746.68,
          1596.84,
          2290.56
        ],
        "rank": 3
      },
      {
        "candidates": [
          865.26,
          2550.066
        ],
        "rank": 4
      }
    ],
    "inventory_id": "402077_1080p",
    "type": "movie",
    "version_id": "op-adbreak-v6",
    "vionlabs_id": "33880c61819a5d50"
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get item ad break result status and data in frames

Deprecated
GET
/results/adbreaks/v3/filter/frame/{inventory_id}

DEPRECATED.

Get the ad breaks result status and data in frames for an item in 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

Path Parameters

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Ad breaks version code

minimum_separation?Minimum Separation

A number of minutes of minimum separation between Ad Breaks

Default1
maximum_separation?Maximum Separation

A number of minutes of maximum separation between Ad Breaks

Default5
skip_first?Skip First

A number of first minutes to skip checking for an Ad Break presence

Default0
skip_last?Skip Last

A number of last minutes to skip checking for an Ad Break presence

Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/results/adbreaks/v3/filter/frame/string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "adbreak": [
      {
        "candidates": [
          265,
          25247,
          50837,
          60040
        ],
        "rank": 1
      },
      {
        "candidates": [
          38385,
          45901
        ],
        "rank": 2
      },
      {
        "candidates": [
          18667,
          39921,
          57264
        ],
        "rank": 3
      },
      {
        "candidates": [
          7650,
          22711
        ],
        "rank": 4
      }
    ],
    "inventory_id": "402077_1080p",
    "type": "movie",
    "version_id": "op-adbreak-v6",
    "vionlabs_id": "33880c61819a5d50"
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get item ad break result status

Deprecated
GET
/results/adbreaks/v3/status/{inventory_id}

DEPRECATED.

Get the ad breaks result status for an item in 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

Path Parameters

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Ad breaks version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/adbreaks/v3/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 the updated inventory_id items with the ad break results statuses ordered by creation/update timestamp

Deprecated
GET
/results/adbreaks/v3/

DEPRECATED.

Get paginated list of inventory items with the updated ad break results ordered by creation/update timestamp.

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?|

Ad breaks version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/adbreaks/v3/"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": [
    {
      "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 item Ad Break candidates

GET
/results/adbreaks/v4/{inventory_id}

Get ad break candidates for an item in 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

Path Parameters

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Ad breaks version code

minimum_separation?Minimum Separation

Minimum separation between ad breaks in minutes. Breaks closer than this are dropped. 0 means no filtering.

Default0
skip_first?Skip First

Number of minutes at the start of the content to exclude ad break candidates from. 0 means no skipping.

Default0
skip_last?Skip Last

Number of minutes at the end of the content to exclude ad break candidates from. 0 means no skipping.

Default0

Response Body

application/json

application/json

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

Get item ad break result status

GET
/results/adbreaks/v4/status/{inventory_id}

Get the ad break processing status for an item without fetching the full candidates payload. Useful for lightweight polling before calling the main GET /{inventory_id} endpoint.

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

inventory_id*Inventory Id

Customer's identifier for a catalog item

Query Parameters

version?|

Ad breaks version code

Response Body

application/json

application/json

curl -X GET "https://example.com/results/adbreaks/v4/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 inventory items with ad break results

GET
/results/adbreaks/v4/

Get a paginated list of inventory items that have ad break results, ordered by creation/update timestamp. Use to bulk-pull newly processed assets.

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?|

Start of time window (ISO 8601). If omitted all results are returned.

to_utcdatetime?|

End of time window (ISO 8601). Defaults to utcnow(). Fix this value while paginating to keep the window stable.

page_num?Page Num

Zero-based page number

Default0
Range0 <= value
page_size?Page Size

Max results per page

Default500
Range1 <= value
version?|

Ad breaks version code

Response Body

application/json

application/json

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

Vionlabs Fingerprint+ API

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

Vionlabs Contextual Ad Breaks API

Vionlabs API for retrieval of Contextual Ad Breaks results.