Skip to main content
GET
Get a collection

Authorizations

x-api-key
string
header
required

Your organisation's API key, supplied by Dizplai. Send it on every request. It isn't a secret, so it can ship in your app: what a fan does is protected by the fan's token.

Path Parameters

collection_id
string<uuid>
required

The collection's ID, from GET /collections. A collection's ID, a UUID.

Example:

"0192fa7b-8b48-768f-90d1-d3ed6f427962"

Query Parameters

include
enum<string>

experiences adds the collection's experiences, in its order: every one that's scheduled, live or closed, in the same shape as List experiences. Leave it out for just the collection.

Available options:
experiences

Response

The collection, and its experiences in its order if you asked for them. Read it when the screen opens and every 30 seconds after, and read an open poll every 10 seconds.

A collection, as Get a collection returns it, with its experiences when asked for.

id
string<uuid>
required

A collection's ID, a UUID.

Example:

"0192fa7b-8b48-768f-90d1-d3ed6f427962"

name
string
required

The collection's name, such as the match, for a screen's heading.

status
string
required

Whether fans can see the collection. offline: not listed, and getting it answers 404. live: listed and shown. Its experiences keep their own status. More statuses may be added: treat one you don't know as offline.

starts_at
string<date-time> | null
required

The match or show's start time, for display. It doesn't open any experience.

ends_at
string<date-time> | null
required

The match or show's end time, for display. It doesn't close any experience.

metadata
object
required

Tags for finding and grouping things, such as the match or show they're about. Filter lists by them with metadata[key]=value. Up to 50 keys of up to 40 characters, values up to 500. One key is reserved, event_id, set by your producers; every other key is yours, and never interpreted.

locale
string
required

The language the collection's text is written in, such as en-GB.

Maximum string length: 35
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$
Example:

"en-GB"

created_at
string<date-time>
required

When the collection was created.

updated_at
string<date-time>
required

When the collection last changed.

experiences
(Poll · object | Fan Voice · object)[]

Only with include=experiences. The collection's experiences, in its order: every one that's scheduled, live or closed, each with its type and in the same shape as List experiences. Draw the types your app knows, and skip any type it doesn't. A collection holds at most 200.

Maximum array length: 200

One experience, shaped by its type: skip a type you don't know. Polls and Fan Voices today; more types are added, never removed.