Skip to content

Content Types

The contentType field on collections identifies what kind of content the collection contains. Use this to filter collections in the list endpoint and to determine how to render content in your display system.

Available types

ValueDescriptionTypical use case
SOCIAL_POSTPosts from fans and official accountsLower-thirds, social walls, ticker feeds
POLLInteractive poll content with voting resultsOn-screen poll graphics
TEXTPlain text content (manually entered)Presenter prompts, audience messages
MEDIAStandalone media content (images, videos)Full-screen media displays
FOOTBALL_PLAYERFootball player dataPlayer profile graphics
FOOTBALL_TEAMFootball team dataTeam lineup displays
FOOTBALL_COMPETITIONFootball competition dataTournament brackets, standings
FOOTBALL_MATCHFootball match dataLive match score graphics
QR_CODEQR code contentOn-screen QR codes for audience interaction
SQUASH_ROUNDSquash round dataRound summary graphics
SQUASH_BRACKETSquash tournament bracket dataBracket displays
SQUASH_MATCHSquash match dataLive match score graphics
SQUASH_PLAYERSquash player dataPlayer profile graphics
SQUASH_COMPETITIONSquash competition dataCompetition overview graphics
SQUASH_TOURNAMENTSquash tournament dataTournament overview displays

Filtering collections

Use the contentType query parameter to filter the list endpoint:

bash
# Only social post collections
curl -H "X-API-Key: your-api-key" \
  "https://api.interplai.app/v1/collections?contentType=SOCIAL_POST"

# Only poll collections
curl -H "X-API-Key: your-api-key" \
  "https://api.interplai.app/v1/collections?contentType=POLL"

INFO

The list of content types may grow over time as new features are added. Your integration should handle unknown content types gracefully (e.g. by ignoring collections with unrecognised types).

Interplai API v1.2.0