Response principles

The exact content of the API JSON response depends on the content type - Stories, Moments, or Videos. The sections that follow detail the common properties and content-specific properties.

Properties

Common properties

Most content types share these common properties:

• id: Unique identifier for the content
• type: Content type (Story, Moment, Video)
• title: Title of the content
• description: Detailed description
• version: Version number
• aspectRatios: Available aspect ratios
• status: Content status (Draft or Active)
• createTime: Creation timestamp
• updateTime: Last update timestamp
• thumbnails: Array of thumbnail images
• geoTargeting: Geographic targeting information
• metadata: Content metadata
• executionTimeType: When content should be shown (PreGame, InGame, PostGame)
• labels: Content labels
• defaultLanguage: Source language of the content (e.g., "en")
• translatedTitles: Dictionary of localized titles mapped to language codes

Story-specific properties

Stories have additional properties:

• isLive: Boolean indicating if the story is live
• htmlUrl: URL to the HTML version of the story
• pages: Array of Page objects representing story pages

Moment-specific properties

Moments have additional properties:

• subtitle: Subtitle text
• duration: Duration of the moment
• translatedDescriptions: Dictionary of localized descriptions
• translatedSubtitles: Dictionary of localized subtitles

Video-specific properties

Videos have additional properties:

• subtitle: Subtitle text
• duration: Duration of the video
• translatedDescriptions: Dictionary of localized descriptions
• translatedSubtitles: Dictionary of localized subtitles

Pagination response

All list endpoints return a pagination response with:

• totalItems: Total number of items available
• result: Array of content items for the current page

Geo-targeting

Content can be targeted to specific geographic regions using:

• includedGeos: Array of regions to include
• excludedGeos: Array of regions to exclude

Metadata

Content can be associated with various entities:

• competition: Competition metadata
• game: Game metadata
• team: Team metadata
• player: Player metadata
• round: Round metadata
• season: Season metadata

Each metadata entity contains:

• provider: Metadata provider name
• providerId: Provider-specific ID
• wscId: WSC ID (integer)

Localization

Localized fields (translatedTitles, translatedDescriptions, translatedSubtitles) are dictionaries where the key is a language or locale code and the value is the localized string.

Example:

"translatedTitles": {
  "en": "Match Highlights",
  "es": "Resumen del partido",
  "fr": "Moments forts du match"
}

The defaultLanguage field indicates the primary language of the content.

Aspect ratios

The API supports various aspect ratios for content:

• Square
• Horizontal
• Vertical
• FourToFive
• FiveToFour
• ThreeToFour
• FourToThree
• TwoToOne
• OneToTwo
• SevenToEight
• EightToSeven
• TwoToThree
• ThreeToOne
• ThreeToTwo
• OneToThree
• ThreeToEight
• FiveToOne
• Unknown