Sign in
Websocket

List registered real-time queries

Returns every active WebSocket query registration of the API key (totalQueries carries the count), each with its registration_id, the query parameters it was registered with (parameter names in lowercase), and active_clients — the number of devices currently connected to the stream for it. Available on plans with WebSocket access.

The API key must be sent as the apikey query parameter — the X-ACCESS-KEY header is not supported on this endpoint. Consumes no API credits.

get/1/websocket/fetch

Query parameters

apikeystring required

Your API key, passed as a query-string parameter. This endpoint does not accept the X-ACCESS-KEY header.

Response

Success.

status'success' required
totalQueriesinteger required

Number of active registrations for this API key.

Changes

Changed in 2 of the 3 revisions of this API.13

  • ece1fd088c7312See the full diff
    • ○

      added the optional property results/oneOf[InvalidFilterDetail]/recommendations to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[InvalidFilterDetail]/recommendations to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[InvalidFilterDetail]/recommendations to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[InvalidFilterDetail]/recommendations to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[InvalidFilterDetail]/recommendations to the response with the 503 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[subschema #3]/items/recommendations to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[subschema #3]/items/recommendations to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[subschema #3]/items/recommendations to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[subschema #3]/items/recommendations to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property results/oneOf[subschema #3]/items/recommendations to the response with the 503 status

      response-optional-property-added

    • ○

      added the required property results/queries/items/active_clients to the response with the 200 status

      response-required-property-added

    • ○

      added the required property totalQueries to the response with the 200 status

      response-required-property-added

  • 692a9e161b3f1See the full diff
    • ○

      endpoint added

      endpoint-added