HTTP API Reference - deprecated methods
The following methods are considered deprecated and have been replaced by new methods documented in the API reference . If you maintain a library please transition to the new methods.
∞ GET channel stats
GET / apps / [app_id] / channels / [channel_name] / stats
Returns statistics for the given channel.
Deprecated 2012-09: use GET channel instead.
No parameters are currently accepted.
∞ Successful response (200)
The following attributes will be returned in the JSON response
|occupied||Boolean||All||Whether or not there are currently any subscribers to this channel|
|user_count||Integer||Presence||Number of distinct users currently subscribed to this channel (a single user may be subscribed many times, but will only count as one)|
|connection_count||Integer||All||Number of connections currently subscribed to this channel. This is a beta feature - please contact support if you would like to try this.|
∞ POST event to channel
Triggers an event on a channel. The event will be triggered on all clients which have subscribed to that channel.
Deprecated 2012-09: use the more flexible POSTevents instead.
Content-Type header should be sent identifying the body of the request as
Parameters (in query string)
This API is an exception to the general rule: parameters must be submitted in the query string.
|name||Event name (required)|
|socket_id||Excludes the event from being sent to a specific connection (see [excluding recipients](/docs/channels/server_api/excluding-event-recipients) )|
This API is an exception to the general rule: parameters must not be submitted in the body.
Request body MUST contain event data as a UTF-8 JSON encoded string. Upon receipt of data which is not valid UTF-8, the API will return a 400 response code. The API does not check that the received data is valid JSON.
∞ Successful response (202)
The event has been received and will be send asynchronously to all sockets. No information is available in the response.