Create Liveblog from external source

This endpoint is only available for customers who have booked this feature. Please ensure your organization has access before using this API.

Overview

This endpoint allows you to create a liveblog for a sports event using data fetched from an external provider. The API pre-fills the liveblog with match data such as teams, players, and scoreboard information. Additionally, automatic posting of events like goals, cards, or substitutions can be configured.

Endpoint

POST /apigw/sports/v2/{organizationId}/liveblog/createFromExternal

Path Parameters

  • organizationId (string, required): The ID of your organization.

Request Body

The request body should contain the following fields:

  • provider (string, required): The name of the external data provider. Only “gn-gsd” (Gracenote) is supported.
  • matchId (string, optional): The ID of the match to fetch from the provider. Either matchId, phaseId or overallId must be provided.
  • phaseId (string, optional): The ID of the phase to fetch from the provider. Either matchId, phaseId or overallId must be provided.
  • overallId (string, optional): The ID of the overall to fetch from the provider. Either matchId, phaseId or overallId must be provided. If phaseId and overallId are supplied at the same time, phaseId is preferred.
  • title (string, optional): Custom title for the liveblog. If not provided, a default title will be generated based on the match data.
  • locale (string, optional): The locale for the liveblog content. Defaults to “en”.
  • autoPostEnabled (boolean, optional): Whether automatic posting of match events is enabled.
  • autoPostConfiguration (AutoPostConfiguration, optional): Configuration for automatic posting if autoPostEnabled is set to true. The configuration can include options to exclude specific events or scoreboards. Everything will be synced if object is missing.

AutoPostConfiguration

  • excludeScoreboard (boolean, optional): Whether to exclude the scoreboard from automatic posting.
  • excludeEvents (string[], optional): An array of event types to exclude from automatic posting.

Auto Post Configuration Example

If you enable automatic posting, the autoPostConfiguration field can be structured like this:

{
  "excludeScoreboard": true,
  "excludeEvents": ["soccer.goal"]
}

Provider

Provider: Heimspiel

  • ID: heim
  • Supported Sport Types:
    • soccer
      • Supported Events:
        • soccer.goal
        • soccer.own-goal
        • soccer.yellow-card
        • soccer.red-card
        • soccer.yellow-red-card
        • soccer.penalty-kick-missed
        • soccer.substitution
        • soccer.start
        • soccer.pause-halves
        • soccer.resume-halves
        • soccer.end-of-regular-play
        • soccer.start-overtime
        • soccer.pause-overtime
        • soccer.resume-overtime
        • soccer.end-of-overtime
        • soccer.start-shootout
        • soccer.end
      • Scoreboard: true

Provider: Gracenote

  • ID: gn-gsd
  • Supported Sport Types:
    • soccer
      • Supported Events:
        • soccer.goal
        • soccer.yellow-card
        • soccer.red-card
        • soccer.substitution
        • soccer.penalty-kick-missed
      • Scoreboard: true
    • cycling
      • Supported Events: (No events supported yet)
      • Scoreboard: false

Responses

Success

Errors

  • 400 Bad Request: If the request is malformed or required data is missing.
  • 422 Unprocessable Entity: If validation of the request data fails (e.g., matchId, phaseId and overallId are missing).
  • 404 Not Found: If the specified route or data source provider is not found.

Example Request

POST /apigw/sports/v2/YOUR_ORGANIZATION_ID/liveblog/createFromExternal

{
  "provider": "gn-gsd",
  "matchId": "12345",
  "locale": "en",
  "autoPostEnabled": true
}