TrackVideo

List TrackVideos

GET https://api.idol.io/api/v2/track-videos

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
    "id"=>"<id of the track video>",
    "type"=>"track-videos",
    "links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id of the track video>"},
    "attributes"=>{
        "readable-retails"=>"Apple Music"
    },
    "relationships"=>{
        "track"=>{
        "links"=>{
            "self"=>"https://api.idol.io/api/v2/track-videos/<id of the track video>/relationships/track",
            "related"=>"https://api.idol.io/api/v2/track-videos/<id of the track video>/track"
        },
        "data"=>{"type"=>"tracks", "id"=>"<track id>"}
        },
        "video"=>{
        "links"=>{
            "self"=>"https://api.idol.io/api/v2/track-videos/<id of the track video>/relationships/video",
            "related"=>"https://api.idol.io/api/v2/track-videos/<id of the track video>/video"
        },
        "data"=>{"type"=>"videos", "id"=>"<video id>"}
        }
    }
    }
],
"meta": {
    "record-count": 1,
    "page-count": 1
},
"links": {
    "first": "https://api.idol.io/api/v2/tracks/<track id>/track-videos?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://api.idol.io/api/v2/tracks/<track id>/track-videos?page%5Bnumber%5D=1&page%5Bsize%5D=20"
}
}

Filter resources

Active

api/v2/groups?filter[active]=true

Get TrackVideo

GET https://api.idol.io/api/v2/track-videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the TrackVideo

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data"=>{
    "id"=>"<id>",
    "type"=>"track-videos",
    "links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>"},
    "relationships"=>{
        "track"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/track", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/track"}, "data"=>{"type"=>"tracks", "id"=>"<id of the track>"}},
        "video"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/video", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/video"}, "data"=>{"type"=>"videos", "id"=>"<id of the video>"}}
    }
  }
}

Create TrackVideo

POST https://api.idol.io/api/v2/track-videos

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
track*	object	Track object
video*	object	Video object
dsps	object	Array of dsp objects

200

{
  "data"=>{
    "id"=>"<id>",
    "type"=>"track-videos",
    "links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>"},
    "relationships"=>{
        "track"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/track", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/track"}, "data"=>{"type"=>"tracks", "id"=>"<id of the track>"}},
        "video"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/video", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/video"}, "data"=>{"type"=>"videos", "id"=>"<id of the video>"}}
    }
  }
}

Update TrackVideo

PUT https://api.idol.io/api/v2/track-videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the TrackVideo

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
track*	object	Track object
video*	object	Video object
dsps	object	Dsp object

200

{
  "data"=>{
    "id"=>"<id>",
    "type"=>"track-videos",
    "links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>"},
    "attributes"=>{
    },
    "relationships"=>{
        "track"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/track", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/track"}, "data"=>{"type"=>"tracks", "id"=>"<id of the track>"}},
        "video"=>{"links"=>{"self"=>"https://api.idol.io/api/v2/track-videos/<id>/relationships/video", "related"=>"https://api.idol.io/api/v2/track-videos/<id>/video"}, "data"=>{"type"=>"videos", "id"=>"<id of the video>"}}
    }
  }
}

Delete TrackVideo

DELETE https://api.idol.io/api/v2/track-videos/:id

Path Parameters

Name	Type	Description
id*	number	ID of the TrackVideo

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200