HTTP API referenceChannel info

GET /apps/{app_id}/channels/{channel_name}

Get info about a single channel.

Query params

ParamDescription
infoComma-separated: user_count (presence only), subscription_count

Plus the four auth params.

Response

{
  "occupied": true,
  "subscription_count": 27,
  "user_count": 14
}

user_count is only returned for presence channels. subscription_count counts every connected socket — a single user with three browser tabs open contributes three subscriptions but one user.

SDK shortcuts

  • PHP$pusher->getChannelInfo('presence-room-42', ['info' => 'user_count,subscription_count'])
  • Nodepusher.get({ path: '/channels/presence-room-42', params: { info: 'user_count,subscription_count' } })