Response: Videos
The information in this page relates to the Videos API.
classDiagram
class Root {
string type
string id
string title
string description
string subtitle
string version
string[] aspectRatios
string status
number duration
datetime createTime
datetime updateTime
Thumbnail[] thumbnails
GeoTargeting geoTargeting
Metadata metadata
Label[] labels
ExtraInfo extraInfo
string executionTimeType
}
class Thumbnail {
string url
string aspectRatio
}
class GeoTargeting {
string[] includedGeos
string[] excludedGeos
}
class Metadata {
Competition competition
Competition[] competitions
Game game
Team team
Player player
string round
Season season
}
class Competition {
string provider
string providerId
string wscId
}
class Game {
string provider
string providerId
string wscId
}
class Team {
string provider
string providerId
string wscId
}
class Player {
string provider
string providerId
string wscId
}
class Season {
string provider
string providerId
string wscId
}
class Label {
string title
string identifier
}
class ExtraInfo {
string homeTeam
string awayTeam
string propertyId
string propertyName
string[] activeLabels
string gameId
string seasonId
string teamId
string playerId
}
Root --> Thumbnail : thumbnails[]
Root --> GeoTargeting : geoTargeting
Root --> Metadata : metadata
Root --> Label : labels[]
Root --> ExtraInfo : extraInfo
Metadata --> Competition : competition
Metadata --> Competition : competitions[]
Metadata --> Game : game
Metadata --> Team : team
Metadata --> Player : player
Metadata --> Season
List of properties with dot notation
| Key | Example Value |
|---|---|
| title | "Match Highlights" |
| description | "Best moments from the final" |
| subtitle | "Championship 2025" |
| version | "v2" |
| aspectRatios\[0] | "16:9" |
| status | "published" |
| duration | 540 |
| createTime | "2025-08-01T18:00:00Z" |
| updateTime | "2025-08-02T10:15:00Z" |
| thumbnails\[0].url | "[https://cdn.example.com/thumb1.jpg](https://cdn.example.com/thumb1.jpg)" |
| thumbnails\[0].aspectRatio | "16:9" |
| thumbnails\[1].url | "[https://cdn.example.com/thumb2.jpg](https://cdn.example.com/thumb2.jpg)" |
| thumbnails\[1].aspectRatio | "4:3" |
| geoTargeting.includedGeos\[0] | "US" |
| geoTargeting.includedGeos\[1] | "UK" |
| geoTargeting.excludedGeos\[0] | "CN" |
| geoTargeting.excludedGeos\[1] | "RU" |
| metadata.competition.provider | "FIFA" |
| metadata.competition.providerId | "fifa\_001" |
| metadata.competition.wscId | "cmp\_123" |
| metadata.competitions\[0].provider | "UEFA" |
| metadata.competitions\[0].providerId | "uefa\_001" |
| metadata.competitions\[0].wscId | "cmp\_456" |
| metadata.game.provider | "ESPN" |
| metadata.game.providerId | "espn\_321" |
| metadata.game.wscId | "game\_987" |
| metadata.team.provider | "Barcelona" |
| metadata.team.providerId | "barca\_11" |
| metadata.team.wscId | "team\_456" |
| metadata.player.provider | "Lionel Messi" |
| metadata.player.providerId | "messi\_10" |
| metadata.player.wscId | "plr\_789" |
| metadata.round | "Final" |
| metadata.season.provider | "La Liga" |
| metadata.season.providerId | "laliga\_2025" |
| metadata.season.wscId | "ssn\_2025" |
| labels\[0].title | "Highlight" |
| labels\[0].identifier | "HL" |
| labels\[1].title | "Top Play" |
| labels\[1].identifier | "TP" |
| extraInfo.homeTeam | "Real Madrid" |
| extraInfo.awayTeam | "Barcelona" |
| extraInfo.propertyId | "prop\_555" |
| extraInfo.propertyName | "Santiago Bernabéu" |
| extraInfo.activeLabels\[0] | "Playoff" |
| extraInfo.activeLabels\[1] | "Live" |
| extraInfo.gameId | "gm\_456" |
| extraInfo.seasonId | "ssn\_2025" |
| extraInfo.teamId | "tm\_789" |
| extraInfo.playerId | "plr\_123" |
| executionTimeType | "auto" |
| defaultLanguage | "en" |
| translatedTitles | { "en": "...", "es": "..." } |
| translatedDescriptions | { } |
| translatedSubtitles | { } |
| competitionId | "51282" |
| publishMethod | null |
| creationSettings.creationTimePeriod | "None" |
| creationSettings.ruleName | null |
| creationSettings.storyType | null |
| game | null |
| rating | null |
Localized text
translatedTitles, translatedDescriptions, and translatedSubtitles are objects keyed by language code. defaultLanguage tells you which language the top-level title, description, and subtitle are in. An object is empty when no translations exist for that field.
Example JSON - doesn't contain all properties
Updated 1 day ago
Did this page help you?
