Liveblog APIs

This documentation covers how to access Liveblogs and Liveblog posts from the Sportal365 Content API

All endpoints described here can be accessed via the Content API under the /liveblogs path.

There are two main entities which are described here:

Liveblogs: the wrapper for all content for a sport event like 'World Cup Final'
Posts: individual content items inside the Liveblog

To access them you need the liveblog feature enabled for your project and account, please contact support for this.

Liveblogs

Data properties

Sports data models

Sports data with which the liveblog is tagged.

competitions
teams
sport_events

For more details see Sports data models

Content data models

These share the same structure as the Content API /v2/{contentType} endpoints, e.g /v2/articles

category
additional_categories
main_media - can contain
- Image
- Video
- Gallery
- Video Embed

Frontend settings

match_header: can be used to show/hide the match_header from the CMS
pagination: can be used to control how many Liveblog posts to show per page

Listing Liveblogs

GET /liveblogs

The endpoint returns a list of liveblog entities.

Supports pagination and several filters, e.g: GET /liveblogs?page=2&limit=20

Supported filters

Consumer facing applications should normally query for ACTIVE or ARCHIVED liveblogs, e.g: /liveblogs?page=1&limit=20&status=ACTIVE,ARCHIVED
Tag filters from Sports APIs
- team_ids
- competition_ids This is the equivalent for /tournaments from the Football API
- sport_event_ids IDs for Football matches
Content filters
- category_ids: Filter by CSV category IDs (main or additional)
- author_ids
type: STANDARD / SPORT_EVENT
- Blogs with SPORT_EVENT will have a Football Match or other sport event linked to them and an automated data feed
- STANDARD is not linked to a sport event

Single liveblog

GET /liveblogs/{idOrSlug}

Returns a single liveblog resolved by the id or the slug field of the liveblog.

The slug field is optional and can be omitted when creating the liveblog, but it is unique.

Liveblog Posts

The endpoint allows paginating over all the Posts in a given liveblog by id/slug

e.g GET /liveblogs/ea7282ed-9f70-4a76-86fc-e31c40ab9cdf/posts?limit=10&page=1&published_type=PUBLISHED

Consumer facing applications should almost always query for published_type=PUBLISHED and not display drafts.

Highlighted posts can be queried using:

/liveblogs/ea7282ed-9f70-4a76-86fc-e31c40ab9cdf/posts?limit=10&page=1&published_type=PUBLISHED&is_highlight=true

Data format notes

minute represents the sport event minute which should be presented for the posts
The related sport entities are in sport_tags
- Currently supported entities are team, coach, player
- For automated posts the order in the list is significant
- The first player is the primary one, goalscorer, player being substituted.
Posts which are automatically published from a data provider will have a sport_event_type
- The code property can take one of the following values:
  - GOAL
  - OWN_GOAL
  - PENALTY_GOAL
  - PENALTY_MISS
  - PENALTY_SHOOTOUT_SCORED
  - PENALTY_SHOOTOUT_MISSED
  - YELLOW_CARD
  - YELLOW_CARD_RED
  - RED_CARD
  - ASSIST
  - SUBSTITUTION
  - VAR
  - SHOTOFF_POST
  - KICKOFF
  - FIRST_HALF
  - HALF_TIME
  - SECOND_HALF
  - FULL_TIME
  - INTERRUPTED
  - ABANDONED
  - FINISHED_AET
  - PENALTY_SHOOTOUT
  - FINISHED_AP
  - FIRST_HALF_EXTRA_TIME
  - SECOND_HALF_EXTRA_TIME
  - WAITING_EXTRA_TIME
  - WAITING_PENALTY_SHOOT_OUT
  - END_FIRST_HALF_EXTRA_TIME
  - PLAY_STOPPED
  - PLAY_RESTARTED
  - INJURY_TIME
  - POSSESSION
Posts are ordered by the display_timestamp value in descending order
Posts can have authors and sponsors: the same data format as in /liveblogs

Post content

Descirbed in detail in Liveblog Posts Body

Liveblog Overview