Stories feeds API

Filter parameters

The following set of parameters is available for the GET methods. When specified in the query, these parameters act as filters, so each one narrows down the request. Applying more than one filter behaves as an ‘AND’ statement.

For example, filtering by player ‘LeBron James’ and game ‘12345’ will result in clips of ‘LeBron James’ from that game only.

Parameter name	Description
`/{id}`	Returns only the object corresponding to the specified ID and ignores other parameters. The ID provided is the internal ID as defined by WSC
`pageSize`	Limits the maximum number of results for the query. The maximum value is 1000
`competitionId`	The competition ID is a unique identifier for a specific competition. This ID is essential for filtering and querying data related to specific competitions
`gameID`	Filters by game ID as defined by the data provider
`teamID`	Filters by team ID as defined by the data provider
`playerID`	Filters by player ID as defined by the data provider
`startDate`	Returns only events that occurred after the specified date and time. Values should be ISO8601 formatted
`endDate`	Returns only events that occurred before the specified date and time. Values should be ISO8601 formatted

Usage example

Example of a filtered API query

https://wscgateway.azurewebsites.net/api/stories?query.competitionID={competition_id}query.gameID={game_id}&query.teamID={team_id}&query.playerID={player_id}&query.startDate={start_date}&query.endDate={end_date}&token={token}

Feed structure

Feeds are provided as JSON messages, each containing a structured set of objects. The following sections describe the main objects returned by the API.

Object Types

The API handles various object types, each representing a different element within the WSC. Below is a summary of these object types:

Name	Description
`Story`	Represents a high-level published story, which can be automatically or manually created
`ProviderID`	A unique identifier for an object as defined by the data provider. Used as a reference to the data provider data
`Player`	Represents a player
`Team`	Represents a team
`Game`	Represents a game
`VideoResolution`	Provides details on the height and width of a video
`VideoCreationSettings`	Parameters defining how the video was created

Object Structure

Story

The Story object is the central element in the Feeds API. It encapsulates all relevant metadata and media associated with a story.

Name	Type	Occurs	Remarks
`Id`	`String`	1..1	A unique identifier as stored in WSC. This ID is used to fetch specific stories, as outlined in the Filter parameters section.
`title`	`String`	1..1	The title of the story
`sdkId`	`String`	0..1	The SDK ID associated with the story. This unique identifier is linked to the SDK version used to create the story, which is useful for managing and tracking SDK-dependent content.
`description`	`String`	1..1	Description of the story.
`storyUrl`	`String`	0..1	A URL providing direct access to the HTML page for the specific story. This URL may be crucial for HTML-based applications, depending on your integration. Utilize it according to your specific requirements.
`geoRestriction`	`Object`	0..1	Deprecated*: `geoRestriction`must not be used in new implementations. Use `geoTargeting` instead.
`geoTargeting`	`Object`	0..1	The `geoTargeting` object allows for more refined geographical content management. It includes options to specify both includedGeos and excludedGeos, offering more control over where the story can be accessed. If the geoTargeting field is null or not present, it indicates that the story has no specific geographical restrictions or targeting, meaning it is accessible globally without any regional limitations
`publishDate`	`DateTime`	1..1	The date and time when the story was published in the feed
`publishMethod`	`String`	1..1	Story published automatically by a rule or manually by a user or via AVGen’s Create flow. `AUTOMATIC` Story published automatically based on predefined rules. `PLATFORM` Story published via the platform's standard content publishing workflow. `MANUAL` Story published manually by a user or content manager
`live`	`Boolean`	1..1	Indicates whether the story is live in WSC meaning that it should continue to get automatic updates
`competitionId`	`String`	1..1	The ID of the competition of which this story was generated
`creationSettings`	`StoryCreationSettings`	0..1	Details regarding the creation of the story. For automatically created stories only
`storyThumbnailUrl`	`String`	0..1	Single URL pointing to the primary thumbnail image for the story
`storyThumbnailUrls`	`List of ThumbnailVersion`	1..*	URLs of the story thumbnail and their corresponding aspect ratio
`lastUpdateTime`	`DateTime`	1..1	The date and time when this story was updated. A story is updated when one of its constituent pages is updated OR its live indication changes

ProviderID

The ProviderID object refers to a unique identifier as defined by the data provider.

Name	Type	Occurs	Description
`provider`	`String`	1..1	The name of the provider
`id`	`String`	1..1	The unique identifier of the relevant object as defined by the provider

Player

The Player object represents a player in the context of a game or competition.

Name	Type	Occurs	Description
`providerPlayerID`	`ProviderID`	1..*	A set of IDs of the player as defined by the different providers
`team`	`Team`	0..1	The team to which this player belongs
`name`	`String`	1..1	Name of the player as defined in WSC

Team

The Team object represents a team in the context of a game or competition.

Name	Type	Occurs	Description
`providerTeamID`	`ProviderID`	1..*	A set of IDs of the team as defined by the different providers
`name`	`String`	1..1	Name of the team as defined in WSC
`locale`	`String`	1..1	Indicates whether the team is Home or Visitor
`score`	`String`	1..1	The score of the team at the time of the event.

Game

The Game object contains details about a specific game within a competition.

Name	Type	Occurs	Description
`id`	`String`	1..1	Unique identifier as stored in WSC
`competitionId`	`String`	1..1	The ID of the competition to which this game belongs
`providerGameID`	`ProviderID`	1..*	A set of IDs of the game as defined by the different providers
`gameDate`	`Date`	1..1	Date & Time of the game
`teams`	`List of Team`	0..*	List of teams participating in the event
`gameStatus`	`String`	1..1	Scheduled / Live / Ended / Postponed / Ignored. Status of the game at the time of querying `Scheduled`The game is scheduled and has not yet started `Live`: The game is currently in progress `Ended`: The game has finished `Ignored`: The game has been ignored for certain reasons `Postponed`: The game has been postponed to a later date
`videos`	`List of GameVideo`	0..*	List of available full game videos
`stadium`	`String`	0..1	The name of the stadium where the game took place

VideoResolution

The VideoResolution object provides the dimensions of a video in terms of height and width.

Name	Type	Occurs	Description
`height`	`Int`	1..1	Height in pixels
`width`	`Int`	1..1	Width in pixels

GameVideo

The GameVideo object contains information about a specific video related to a game.

Name	Type	Occurs	Description
`StreamName`	`String`	1..1	Name of the stream (e.g., Home, Away, National)
`Url`	`String`	1..1	URL of the video

VideoVersion

The VideoVersion object provides details about different versions of a video.

Name	Type	Occurs	Description
`md5`	`String`	1..1	MD5 checksum of the video. Optional parameter, depending on configuration
`url`	`String`	1..1	URL of the video version

ThumbnailVersion

The ThumbnailVersion object contains information about different versions of thumbnail images for videos.

Name	Type	Occurs	Description
`url`	`String`	1..1	URL of the video version
`aspectRatio`	`String`	1..1	Aspect ratio of the thumbnail (e.g., 16:9, 1:1, 4:5, 9:16)

StoryCreationSettings

The StoryCreationSettings object provides details regarding the creation of a story, particularly those created automatically.

Name	Type	Occurs	Description
`ruleName`	`String`	0..1	The name of the rule that created the Story. Relevant only for stories created automatically by a rule
`creationTimePeriod`	`String`	1..1	Indicates the time period during which the story was created (e.g., IN-GAME, POST-GAME). `PRE-GAME`: Indicates that the story was created before the game. `IN-GAME`: Indicates that the story was created during the game. `POST-GAME`: Indicates that the story was created after the game
`storyType`	`String`	1..1	Type of the story, such as Highlights, Top plays, etc. `Top Plays` A story type focusing on the top plays of a game or event. `Highlight`: A story type that compiles the highlights of a game or event. `Mix`: A story type that combines various clips from different sources. `Condensed` A story type that offers a shortened version of the full event. `Story` A general story type, often used for narrative-style compilations.

KeyValue

The KeyValue object is a generic key-value pair used throughout the API.

Name	Type	Occurs	Description
`key`	`String`	1..1	Name of the parameter or field
`value`	`String`	1..1	Value of the parameter or field as stored by WSC

Competition

The Competition object provides details about a specific competition within the WSC system.

Name	Type	Occurs	Description
`competitionName`	`String`	1..1	Name of the Competition
`competitionId`	`String`	1..1	ID of the Competition

JSON example

{
  "id": "0A30DB1DA38FB0AA589FC4542338BECC2FAB7D00",
  "title": "Team A vs.Team B - Game Highlights",
  "sdkId": "66ba3c724167b0d08aaas1c2",
  "storyUrl": "https://the-story-url.html",
  "geoTargeting": {
    "includedGeos": [
      "us",
      "ar"
    ]
  },
  "game": {
    "id": "12810a30-952f-b051-25d8-3aad152c13dd",
    "competitionId": "22",
    "providerGameId": [
      {
        "provider": "Provider name",
        "id": "123456789"
      }
    ],
    "gameDate": "2024-07-21T21:00:00",
    "teams": [
      {
        "providerTeamId": [
          {
            "provider": "Provider name",
            "id": "123456789"
          }
        ],
        "name": "Team A name",
        "locale": "Home",
        "score": "98"
      },
      {
        "providerTeamId": [
          {
            "provider": "Provider name",
            "id": "987654321"
          }
        ],
        "name": "Team B name ",
        "locale": "Visitor",
        "score": "103"
      }
    ],
    "gameStatus": "Ended",
    "stadium": "stadium name"
  },
  "description": "Team A vs.Team B - Game Highlights, 21-07-24, Regular Season, 2024-25",
  "publishDate": "2024-08-12T16:46:47.211137Z",
  "publishMethod": "AUTOMATIC",
  "live": false,
  "competitionId": "22",
  "creationSettings": {
    "ruleName": "EVERY Game - Game Highlights",
    "creationTimePeriod": "POST-GAME",
    "storyType": "Highlight"
  },
  "storyThumbnailUrl": "https://thumbnail.jpg",
  "storyThumbnailUrls": [
    {
      "url": "https://thumbnail1.jpg",
      "aspectRatio": "1x1"
    },
    {
      "url": "https://thumbnail2.jpg",
      "aspectRatio": "2x3"
    },
    {
      "url": "https://thumbnail3.jpg",
      "aspectRatio": "16x9"
    }
  ],
  "lastUpdateTime": "2024-08-12T16:46:48.8927688Z"
}

Updated 1 day ago

Did this page help you?