Videos Data
Get a video
Get data for a music video.
Get a video by ID
/videos/09ad4078-b1d0-4cc3-808e-e99ed715f877Video response
{
"data": {
"type": "videos",
"id": "09ad4078-b1d0-4cc3-808e-e99ed715f877",
"attributes": {
"reference": "TV24710765",
"songTitle": "Dune",
"songSlug": "dune",
"url": "https://tinyvisions.nz/videos/beastwars/dune",
"synopsis": null,
"yearReleased": 2013,
"duration": 186,
"aspectRatio": "4:3",
"nzOnAirFunded": 1,
"versionCount": 1,
"versionName": null,
"versionNumber": 1,
"artists": [
{
"id": "7b397dd1-f627-467c-bdbc-f850a118e099",
"reference": "TV22181883",
"name": "Beastwars",
"slug": "beastwars",
"url": "https://tinyvisions.nz/who/beastwars",
"profile": "New Zealand sludge metal four-piece Beastwars abide by one steadfast maxim: Obey the Riff.",
"isPrimary": 1
}
],
"directors": [
{
"id": "bd6b95e4-eac5-4111-b3e0-3888c08b181d",
"reference": "TV19889265",
"name": "Simon Ward",
"slug": "simon-ward",
"url": "https://tinyvisions.nz/who/simon-ward",
"profile": null,
"isPrimary": 1
}
],
"labels": [
{
"id": "7a7d99f6-74fc-4161-9304-f9da8b6d4c9c",
"reference": "TV28934042",
"name": "Destroy Records",
"slug": "destroy-records",
"url": "https://tinyvisions.nz/who/destroy-records",
"profile": null,
"isPrimary": 1
}
],
"created": "2021-04-23T23:55:00+12:00",
"updated": "2022-05-23T13:31:00+12:00"
},
"links": {
"self": "https://tinyvisions.nz/videos/09ad4078-b1d0-4cc3-808e-e99ed715f877"
}
}
}
Parameters
Additional data can be returned with an ?include= query appended to the resource request.
Credits
- Collection of
Entitiesdata filtered by a video’s credits. Images
- A collection of formats and sizes for a
posterimage representative of a video’s content. Streams
- A collection of sources for 3rd-party streams of a video.
Tags
- A collection of non-hierarchical terms classifying a video.
Albums
- Album data associated with a video.
Query a single parameter
?include=streamsQuery multiple parameters
?include=credits,images,streams,tagsCredits
Get credits data associated with a video.
Get credits
?include=creditsCredits response
{
"included": [
{
"type": "credits",
"id": "1b283d5a-94e4-4883-b500-9c3eaad6b9ab",
"attributes": {
"creditType": "Label",
"creditNotes": null,
"isPrimary": 1,
"entity": {
"id": "7a7d99f6-74fc-4161-9304-f9da8b6d4c9c",
"reference": "TV28934042",
"name": "Destroy Records",
"slug": "destroy-records",
"url": "https://tinyvisions.nz/who/destroy-records",
"profile": null
}
}
},
{
"type": "credits",
"id": "405bb49c-392d-4467-99cd-606cae68a844",
"attributes": {
"creditType": "Director",
"creditNotes": null,
"isPrimary": 1,
"entity": {
"id": "bd6b95e4-eac5-4111-b3e0-3888c08b181d",
"reference": "TV19889265",
"name": "Simon Ward",
"slug": "simon-ward",
"url": "https://tinyvisions.nz/who/simon-ward",
"profile": null
}
}
}
]
}
Images
Get images data associated with a video.
Content
posteris a screen-capture from the video content.Aspect ratio
- All poster images are standardised to 16:9, regardless of a source video’s aspect ratio.
Get images
?include=imagesImages response
{
"included": [
{
"type": "images",
"id": "ddd3ffa0-203c-4bc2-bd30-19b3e9024397",
"attributes": {
"poster": {
"jpg": {
"small": "https://tinyvisions.nz/images/posters/beastwars-123456789-s.jpg",
"medium": "https://tinyvisions.nz/images/posters/beastwars-123456789-m.jpg",
"large": "https://tinyvisions.nz/images/posters/beastwars-123456789-l.jpg",
"raw": "https://tinyvisions.nz/images/posters/beastwars-123456789-r.jpg"
},
"webp": {
"small": "https://tinyvisions.nz/images/posters/beastwars-123456789-s.webp",
"medium": "https://tinyvisions.nz/images/posters/beastwars-123456789-m.webp",
"large": "https://tinyvisions.nz/images/posters/beastwars-123456789-l.webp",
"raw": "https://tinyvisions.nz/images/posters/beastwars-123456789-r.webp"
}
}
}
}
]
}
Streams
Get streams data associated with a video.
Get streams
?include=streamsStreams response
{
"included": [
{
"type": "streams",
"id": "b223a404-a847-4036-ac8d-a23d57e350ba",
"attributes": {
"sources": [
{
"source": "vimeo",
"sourceId": null,
"isPrimary": 0
},
{
"source": "youtube",
"sourceId": "CIZQHR6-Ngg",
"isPrimary": 1
}
]
}
}
]
}
Tags
Get tags data associated with a video.
Get tags
?include=tagsTags response
{
"included": [
{
"type": "tags",
"id": "2e13a009-c201-4e1f-a492-37455082dcc6",
"attributes": {
"tagName": "",
"tagSlug": "",
"tagType": "",
"tagDescription": []
}
}
]
}
Albums
Get albums data associated with a video.
Get an album
?include=albumsAlbum response
{
"included": [
{
"type": "albums",
"id": "ed2815eb-ac01-41b5-a61d-046adb7fbc6b",
"attributes": {
"albumName": "Blood Becomes Fire",
"albumSlug": "blood-becomes-fire",
"albumNotes": null
}
}
]
}
Album image
Get the cover image associated with an album.
Get an album cover
?include=albums.images