{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:ably-platform/get-metadata-of-all-channels":{"get":{"operationId":"cloud_ably_platform_get_metadata_of_all_channels","summary":"Enumerate all active channels of the application","description":"GET /channels","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100}},{"name":"prefix","in":"query","required":false,"description":"Optionally limits the query to only those channels whose name starts with the given prefix","schema":{"type":"string","description":"Optionally limits the query to only those channels whose name starts with the given prefix"}},{"name":"by","in":"query","required":false,"description":"optionally specifies whether to return just channel names (by=id) or ChannelDetails (by=value)","schema":{"type":"string","enum":["value","id"],"description":"optionally specifies whether to return just channel names (by=id) or ChannelDetails (by=value)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-metadata-of-channel":{"get":{"operationId":"cloud_ably_platform_get_metadata_of_channel","summary":"Get metadata of a channel","description":"GET /channels/{channel_id}","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"channel_id","in":"query","required":true,"description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels).","schema":{"type":"string","description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-messages-by-channel":{"get":{"operationId":"cloud_ably_platform_get_messages_by_channel","summary":"Get message history for a channel","description":"GET /channels/{channel_id}/messages","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"channel_id","in":"query","required":true,"description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels).","schema":{"type":"string","description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels)."}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":"100"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","default":"now"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["forwards","backwards"],"default":"backwards"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/publish-messages-to-channel":{"post":{"operationId":"cloud_ably_platform_publish_messages_to_channel","summary":"Publish a message to a channel","description":"POST /channels/{channel_id}/messages","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel_id"],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"channel_id":{"type":"string","description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels)."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-presence-of-channel":{"get":{"operationId":"cloud_ably_platform_get_presence_of_channel","summary":"Get presence of a channel","description":"GET /channels/{channel_id}/presence","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"channel_id","in":"query","required":true,"description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels).","schema":{"type":"string","description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels)."}},{"name":"clientId","in":"query","required":false,"schema":{"type":"string"}},{"name":"connectionId","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-presence-history-of-channel":{"get":{"operationId":"cloud_ably_platform_get_presence_history_of_channel","summary":"Get presence history of a channel","description":"GET /channels/{channel_id}/presence/history","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"channel_id","in":"query","required":true,"description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels).","schema":{"type":"string","description":"The [Channel's ID](https://www.ably.io/documentation/rest/channels)."}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":"100"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","default":"now"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["forwards","backwards"],"default":"backwards"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/request-access-token":{"post":{"operationId":"cloud_ably_platform_request_access_token","summary":"Request an access token","description":"POST /keys/{keyName}/requestToken","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyName"],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"keyName":{"type":"string","description":"The [key name](https://www.ably.io/documentation/rest-api/token-request-spec#api-key-format) comprises of the app ID and key ID of an API…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-push-subscriptions-on-channels":{"get":{"operationId":"cloud_ably_platform_get_push_subscriptions_on_channels","summary":"List channel subscriptions","description":"GET /push/channelSubscriptions","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"channel","in":"query","required":false,"description":"Filter to restrict to subscriptions associated with that channel.","schema":{"type":"string","description":"Filter to restrict to subscriptions associated with that channel."}},{"name":"deviceId","in":"query","required":false,"description":"Optional filter to restrict to devices associated with that deviceId. Cannot be used with clientId.","schema":{"type":"string","description":"Optional filter to restrict to devices associated with that deviceId. Cannot be used with clientId."}},{"name":"clientId","in":"query","required":false,"description":"Optional filter to restrict to devices associated with that clientId. Cannot be used with deviceId.","schema":{"type":"string","description":"Optional filter to restrict to devices associated with that clientId. Cannot be used with deviceId."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records to return.","schema":{"type":"integer","default":100,"description":"The maximum number of records to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/subscribe-push-device-to-channel":{"post":{"operationId":"cloud_ably_platform_subscribe_push_device_to_channel","summary":"Subscribe a device to a channel","description":"POST /push/channelSubscriptions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/delete-push-device-details":{"post":{"operationId":"cloud_ably_platform_delete_push_device_details","summary":"Delete a registered device's update token","description":"DELETE /push/channelSubscriptions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"channel":{"type":"string","description":"Filter to restrict to subscriptions associated with that channel."},"deviceId":{"type":"string","description":"Must be set when clientId is empty, cannot be used with clientId."},"clientId":{"type":"string","description":"Must be set when deviceId is empty, cannot be used with deviceId."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-channels-with-push-subscribers":{"get":{"operationId":"cloud_ably_platform_get_channels_with_push_subscribers","summary":"List all channels with at least one subscribed device","description":"GET /push/channels","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-registered-push-devices":{"get":{"operationId":"cloud_ably_platform_get_registered_push_devices","summary":"List devices registered for receiving push notifications","description":"GET /push/deviceRegistrations","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"deviceId","in":"query","required":false,"description":"Optional filter to restrict to devices associated with that deviceId.","schema":{"type":"string","description":"Optional filter to restrict to devices associated with that deviceId."}},{"name":"clientId","in":"query","required":false,"description":"Optional filter to restrict to devices associated with that clientId.","schema":{"type":"string","description":"Optional filter to restrict to devices associated with that clientId."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of records to return.","schema":{"type":"integer","default":100,"description":"The maximum number of records to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/register-push-device":{"post":{"operationId":"cloud_ably_platform_register_push_device","summary":"Register a device for receiving push notifications","description":"POST /push/deviceRegistrations","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/unregister-all-push-devices":{"post":{"operationId":"cloud_ably_platform_unregister_all_push_devices","summary":"Unregister matching devices for push notifications","description":"DELETE /push/deviceRegistrations","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"deviceId":{"type":"string","description":"Optional filter to restrict to devices associated with that deviceId. Cannot be used with clientId."},"clientId":{"type":"string","description":"Optional filter to restrict to devices associated with that clientId. Cannot be used with deviceId."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-push-device-details":{"get":{"operationId":"cloud_ably_platform_get_push_device_details","summary":"Get a device registration","description":"GET /push/deviceRegistrations/{device_id}","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"device_id","in":"query","required":true,"description":"Device's ID.","schema":{"type":"string","description":"Device's ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/put-push-device-details":{"post":{"operationId":"cloud_ably_platform_put_push_device_details","summary":"Update a device registration","description":"PUT /push/deviceRegistrations/{device_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["device_id"],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"device_id":{"type":"string","description":"Device's ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/patch-push-device-details":{"post":{"operationId":"cloud_ably_platform_patch_push_device_details","summary":"Update a device registration","description":"PATCH /push/deviceRegistrations/{device_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["device_id"],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"device_id":{"type":"string","description":"Device's ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/unregister-push-device":{"post":{"operationId":"cloud_ably_platform_unregister_push_device","summary":"Unregister a single device for push notifications","description":"DELETE /push/deviceRegistrations/{device_id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["device_id"],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"device_id":{"type":"string","description":"Device's ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/update-push-device-details":{"get":{"operationId":"cloud_ably_platform_update_push_device_details","summary":"Reset a registered device's update token","description":"GET /push/deviceRegistrations/{device_id}/resetUpdateToken","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"device_id","in":"query","required":true,"description":"Device's ID.","schema":{"type":"string","description":"Device's ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/publish-push-notification-to-devices":{"post":{"operationId":"cloud_ably_platform_publish_push_notification_to_devices","summary":"Publish a push notification to device(s)","description":"POST /push/publish","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Ably-Version":{"type":"string","description":"The version of the API you wish to use."},"format":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-stats":{"get":{"operationId":"cloud_ably_platform_get_stats","summary":"Retrieve usage statistics for an application","description":"GET /stats","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":"100"}},{"name":"end","in":"query","required":false,"schema":{"type":"string","default":"now"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["forwards","backwards"],"default":"backwards"}},{"name":"unit","in":"query","required":false,"description":"Specifies the unit of aggregation in the returned results.","schema":{"type":"string","enum":["minute","hour","day","month"],"default":"minute","description":"Specifies the unit of aggregation in the returned results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:ably-platform/get-time":{"get":{"operationId":"cloud_ably_platform_get_time","summary":"Get the service time","description":"GET /time","tags":["cloud"],"parameters":[{"name":"X-Ably-Version","in":"query","required":false,"description":"The version of the API you wish to use.","schema":{"type":"string","description":"The version of the API you wish to use."}},{"name":"format","in":"query","required":false,"description":"The response format you would like","schema":{"type":"string","enum":["json","jsonp","msgpack","html"],"description":"The response format you would like"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}