This endpoint allows you to get overlays that can be displayed during video playback.
These overlays are commonly used for disclaimers, e-learning and special offers.

Collection /overlay

Get /overlay

Get all non disabled overlays (collection) for a specific organisation.
NB, normal users will only be able to get overlays for their own organisation.

item value
Access user, system
Full url https://api.buto.tv/v2/overlay?organisation_id=Bbgwg
verb GET
params string:organisation_id:eg Bbgwg

Example usage

#get video analytics for an organisation during Jan 2014
curl -u <YOUR_API_KEY>:x --include https://api.buto.dev/v2/overlay\?organisation_id\=Bbgwg

returns

HTTP/1.1 200 OK
...
Content-Type: application/json
{
    -0: {
        in_player_ad_id: "ia8CRrn"
        associated_with_media_id: "Pt7g7"
        organisation_id: "Bbgwg"
        title: "disclaimer Test"
        description: "Lorem Ipsum is dummy text for typesetting ..."
        ...
        disabled: "0"
}
    -1: {
        in_player_ad_id: "ia2qvzr"
        associated_with_media_id: "RZCt7"
        organisation_id: "Bbgwg"
...

GET /overlay/:id

Get a specific overlay by ID

item value
Access user, system
Full url https://api.buto.tv/v2/overlay/{id}
verb GET
params string:overlay_id: eg z8j3hd

Example usage

#get video analytics for an organisation during Jan 2014
curl -u <YOUR_API_KEY>:x --include https://api.buto.dev/v2/overlay/ia8CRrn

returns

HTTP/1.1 200 OK
...
Content-Type: application/json
{
    in_player_ad_id: "ia8CRrn"
    associated_with_media_id: "Pt7g7"
    organisation_id: "Bbgwg"
    title: "disclaimer Test"
    description: "Lorem Ipsum is dummy text for typesetting ..."
    ...
    disabled: "0"
}
...