Skip to content
Embabel Worlds

Channels this world's content declares, with what each unlocks

GET
/api/v1/audience/channels
curl --request GET \
  --url http://localhost:11044/api/v1/audience/channels \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Deliberately unfiltered: a channel nobody has joined is the one somebody needs to find. Only the channel’s NAME and its counts are exposed — the content stays gated.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

The audience channels this world offers and the ones the acting user has joined. Answered by GET /audience/channels and, after the change, by PUT /audience/channels.

object
joined
required

The channels the acting user has joined, sorted by name; may include channels nothing currently declares

Array<string>
offered
required

Every channel a view or app in this world declares, whether or not anybody has joined it, sorted by name. Empty when the world could not be loaded

Array<object>

One audience channel this world’s content declares, and how much content joining it would reach.

object
apps
required

Number of apps in this world that declare the channel

integer format: int32
channel
required

Channel name, normalised to trimmed lowercase

string
views
required

Number of saved views in this world that declare the channel

integer format: int32

Example generated

{
  "joined": [
    "example"
  ],
  "offered": [
    {
      "apps": 1,
      "channel": "example",
      "views": 1
    }
  ]
}