Skip to main content
GET
Get broadcastCampaign resource

Authorizations

X-API-KEY
string
header
required

Use the format X-API-KEY YOUR_API_KEY. Each key is tied to a single broadcast.

Path Parameters

userId
string<objectId>
required

Resource identifier.

broadcastId
string<objectId>
required

Resource identifier.

broadcastCampaignId
string<objectId>
required

Resource identifier.

Response

200 - application/json

Success

_id
string<objectId>
required
Example:

"64b7f8b6f23a4a4f3d0a9b12"

_createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

media
unknown
status
enum<string> | null
Available options:
draft,
published
Example:

"draft"

blocks
(media · object | button · object | divider · object | embed · object | question · object | paragraph · object | sessions · object | hosts · object | interestPoints · object | articles · object | countdown · object | section · object | socials · object | meteo · object | map · object)[] | null

Bloc de contenu rendu dans l'ordre du tableau. Type peut être title pour un titre, paragraph pour un texte markdown, media pour une image ou une video, embed pour un contenu embarqué (ex: tweet, video externe, etc), button pour un bouton cliquable, question pour une question avec reponses cliquables, sessions, hosts ou interestPoints pour afficher des listes de sessions, hosts ou points d'interet d'un broadcast, articles pour afficher une selection d'articles d'un broadcast, ou countdown pour afficher un compte a rebours vers une date cible.

title
string | null
Example:

"string"

description
string | null
Example:

"string"

navigator
object | null

Destination de navigation d'une tuile ou d'un bouton.

notificationMedia
unknown
notificationTitle
string | null
Example:

"string"

notificationDescription
string | null
Example:

"string"

sentCount
integer | null
Required range: 0 <= x <= 9007199254740991
Example:

0

openedCount
integer | null
Required range: 0 <= x <= 9007199254740991
Example:

0

localeDetails
object | null
defaultLocale
enum<string> | null
Available options:
fr,
en,
es
Example:

"fr"

metadata
object
_updatedAt
string<date-time> | null
Example:

"2024-01-01T00:00:00.000Z"

_reference
string | null
Example:

"string"