You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/auth/capabilities.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ API keys and Ably-compatible tokens, have a set of capabilities assigned to them
7
7
8
8
API keys are long-lived, secret and typically not shared with clients. API key capabilities are configured using the [dashboard](https://ably.com/dashboard), or using the [Control API](/docs/platform/account/control-api).
9
9
10
-
Ably-compatible tokens are designed to be shared with untrusted clients, are short-lived, and can be configured and issued programmatically. **For restricting client access to channels, tokens provide far more flexibility and security than API key capabilities.** See [selecting an authentication mechanism](/docs/auth#selecting-auth) to understand why token authentication is the preferred option in most scenarios.
10
+
Ably-compatible tokens are designed to be shared with untrusted clients, are short-lived, and can be configured and issued programmatically. For restricting client access to channels, tokens provide far more flexibility and security than API key capabilities. See [selecting an authentication mechanism](/docs/auth#selecting-auth) to understand why token authentication is the preferred option in most scenarios.
Copy file name to clipboardExpand all lines: src/pages/docs/metadata-stats/stats.mdx
+32-32Lines changed: 32 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ curl --request GET \
43
43
This endpoint returns a [statistics response type](#payload) including [account-only metrics](#account-only).
44
44
45
45
<Asidedata-type='note'>
46
-
To obtain your `ACCOUNT_ID`, you can use `/me` Control API endpoint to find your `ACCOUNT_ID`, or alternatively find it in the [**Settings**](https://ably.com/accounts/any/edit) page of your account dashboard:
46
+
To obtain your `ACCOUNT_ID`, you can use `/me` Control API endpoint to find your `ACCOUNT_ID`, or alternatively find it in the [Settings](https://ably.com/accounts/any/edit) page of your account dashboard:
This endpoint returns a [statistics response type](#payload).
86
86
87
87
<Asidedata-type='note'>
88
-
The `APP_ID` can be found in the [**Settings**](https://ably.com/accounts/any/apps/any/edit) tab of an application within your dashboard.
88
+
The `APP_ID` can be found in the [Settings](https://ably.com/accounts/any/apps/any/edit) tab of an application within your dashboard.
89
89
</Aside>
90
90
91
91
### App statistics via SDK <aid="app-sdk"/>
@@ -360,45 +360,45 @@ The following metadata is returned for each entry:
360
360
361
361
| Property | Description |
362
362
| --- | --- |
363
-
|**appId**| The ID of the Ably application the statistics are for. Only present when querying app statistics. |
364
-
|**accountId**| The ID of the Ably account the statistics are for. Only present when querying account statistics. |
365
-
|**intervalId**| Start time for the stats entry. Format is `yyyy-mm-dd:hh:mm` for `unit=minute`, and `yyyy-mm-dd:hh` for `unit=hour,day,month`. |
366
-
|**unit**| Unit of time that the stats entry covers. One of `minute`, `hour`, `day` or `month`. |
367
-
|**schema**| URI of the stats schema. |
368
-
|**inProgress**| The last sub-interval included in this entry in the format `yyyy-mm-dd:hh:mm:ss`, else undefined. For entries that are still in progress, such as the current month. |
363
+
| appId | The ID of the Ably application the statistics are for. Only present when querying app statistics. |
364
+
| accountId | The ID of the Ably account the statistics are for. Only present when querying account statistics. |
365
+
| intervalId | Start time for the stats entry. Format is `yyyy-mm-dd:hh:mm` for `unit=minute`, and `yyyy-mm-dd:hh` for `unit=hour,day,month`. |
366
+
| unit | Unit of time that the stats entry covers. One of `minute`, `hour`, `day` or `month`. |
367
+
| schema | URI of the stats schema. |
368
+
| inProgress | The last sub-interval included in this entry in the format `yyyy-mm-dd:hh:mm:ss`, else undefined. For entries that are still in progress, such as the current month. |
369
369
370
370
### All messages <aid="messages"/>
371
371
372
372
All messages metrics include all messages types, such as those sent and received by Ably and clients, messages delivered via integrations and push notifications delivered to devices.
373
373
374
374
Failed vs. Refused messages:
375
-
-**Failed** messages are those that did not succeed for reasons other than Ably actively rejecting them, such as external integration target rejections or Ably service issues.
376
-
-**Refused** messages are those that Ably actively chose to reject, typically due to rate limiting, malformed messages, or insufficient client permissions.
375
+
- Failed messages are those that did not succeed for reasons other than Ably actively rejecting them, such as external integration target rejections or Ably service issues.
376
+
- Refused messages are those that Ably actively chose to reject, typically due to rate limiting, malformed messages, or insufficient client permissions.
377
377
378
378
| Metric | Description |
379
379
| --- | --- |
380
-
|**messages.all.all.count**| Total number of messages that were successfully received and sent by Ably, summed over all message types and transports. |
381
-
|**messages.all.all.billableCount**| Total number of billable messages that were successfully received and sent by Ably, summed over all message types and transports. |
382
-
|**messages.all.all.data**| Total data in messages successfully received and sent by Ably, summed over all message types and transports. |
383
-
|**messages.all.all.uncompressedData**| Total data in messages successfully received and sent by Ably, excluding savings provided by delta compression. |
384
-
|**messages.all.all.failed**| Total number of messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
385
-
|**messages.all.all.refused**| Total number of messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions.|
386
-
|**messages.all.messages.count**| Total message count, excluding presence and object messages. |
387
-
|**messages.all.messages.billableCount**| Total billable message count, excluding presence and object messages. |
388
-
|**messages.all.messages.data**| Total message size, excluding presence and object messages. |
389
-
|**messages.all.messages.uncompressedData**| Total number of messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
390
-
|**messages.all.messages.failed**| Total number of messages excluding presence and object messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
391
-
|**messages.all.messages.refused**| Total number of messages excluding presence and object messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions. |
392
-
|**messages.all.presence.count**| Total presence message count. |
393
-
|**messages.all.presence.billableCount**| Total billable presence message count. |
394
-
|**messages.all.presence.data**| Total presence message size. |
395
-
|**messages.all.presence.uncompressedData**| Total uncompressed presence message size, excluding delta compression. |
396
-
|**messages.all.objects.count**| Total objects message count. |
397
-
|**messages.all.objects.billableCount**| Total billable objects message count. |
398
-
|**messages.all.objects.data**| Total objects message size. |
399
-
|**messages.all.objects.uncompressedData**| Total uncompressed objects message size, excluding delta compression. |
400
-
|**messages.all.messages.failed**| Total number of presence messages excluding presence and object messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
401
-
|**messages.all.messages.refused**| Total number of presence messages excluding presence and object messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions. |
380
+
|`messages.all.all.count`| Total number of messages that were successfully received and sent by Ably, summed over all message types and transports. |
381
+
|`messages.all.all.billableCount`| Total number of billable messages that were successfully received and sent by Ably, summed over all message types and transports. |
382
+
|`messages.all.all.data`| Total data in messages successfully received and sent by Ably, summed over all message types and transports. |
383
+
|`messages.all.all.uncompressedData`| Total data in messages successfully received and sent by Ably, excluding savings provided by delta compression. |
384
+
|`messages.all.all.failed`| Total number of messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
385
+
|`messages.all.all.refused`| Total number of messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions.|
386
+
|`messages.all.messages.count`| Total message count, excluding presence and object messages. |
387
+
|`messages.all.messages.billableCount`| Total billable message count, excluding presence and object messages. |
388
+
|`messages.all.messages.data`| Total message size, excluding presence and object messages. |
389
+
|`messages.all.messages.uncompressedData`| Total number of messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
390
+
|`messages.all.messages.failed`| Total number of messages excluding presence and object messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
391
+
|`messages.all.messages.refused`| Total number of messages excluding presence and object messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions. |
392
+
|`messages.all.presence.count`| Total presence message count. |
393
+
|`messages.all.presence.billableCount`| Total billable presence message count. |
394
+
|`messages.all.presence.data`| Total presence message size. |
395
+
|`messages.all.presence.uncompressedData`| Total uncompressed presence message size, excluding delta compression. |
396
+
|`messages.all.objects.count`| Total objects message count. |
397
+
|`messages.all.objects.billableCount`| Total billable objects message count. |
398
+
|`messages.all.objects.data`| Total objects message size. |
399
+
|`messages.all.objects.uncompressedData`| Total uncompressed objects message size, excluding delta compression. |
400
+
|`messages.all.messages.failed`| Total number of presence messages excluding presence and object messages that failed. These are messages which did not succeed for some reason other than Ably explicitly refusing them, such as they were rejected by an external integration target, or a service issue on Ably's side. |
401
+
|`messages.all.messages.refused`| Total number of presence messages excluding presence and object messages that were refused by Ably. For example, due to [rate limiting](/docs/platform/pricing/limits), malformed messages, or incorrect client permissions. |
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/api.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,10 +43,10 @@ Set resource restrictions to control access to channels and queues, ranging from
43
43
44
44
| Restriction | Description |
45
45
| ----------- | ----------- |
46
-
|**None**| No restrictions; access any channel or queue. |
47
-
|**Only channels**| Access any channel but not queues. |
48
-
|**Only queues**| Access any queue but not channels. |
49
-
|**Selected channels and queues**| Specify explicit rules for access. |
46
+
| None | No restrictions; access any channel or queue. |
47
+
| Only channels | Access any channel but not queues. |
48
+
| Only queues | Access any queue but not channels. |
49
+
| Selected channels and queues | Specify explicit rules for access. |
50
50
51
51
When specifying selected channels and queues, you can provide a comma-separated list of resources. Each resource can match a single channel (e.g., `channel-name`) or multiple channels using wildcards (e.g., `namespace:*`). Queues use the prefix `[queue]` and meta channels use `[meta]`. See [capabilities documentation](/docs/auth/capabilities#wildcards) for detailed wildcard syntax.
52
52
@@ -60,7 +60,7 @@ A single API key cannot support complex permission combinations, such as publish
60
60
61
61
| Option | Description |
62
62
| ------ | ----------- |
63
-
|**Revocable tokens**| Implement security measures by setting shorter token lifetimes and enabling the ability to revoke tokens issued by the API key. |
63
+
| Revocable tokens | Implement security measures by setting shorter token lifetimes and enabling the ability to revoke tokens issued by the API key. |
Copy file name to clipboardExpand all lines: src/pages/docs/platform/account/app/settings.mdx
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,33 +17,33 @@ The following provides an overview of your application settings.
17
17
|**App ID**| This ID is automatically generated by Ably when you create an application. It is a critical part of your application's identity and is included in every API key and token issued for your application. |
18
18
|**Name**| This is the user-defined name that you assigned when creating your application. It is helpful for quickly identifying the application among others in your dashboard, especially if you manage multiple applications. |
19
19
|**Security**| Enabled by default, this option enforces Transport Layer Security (TLS) for all connections to your application. TLS protocol ensures data encryption and secure communication between clients and servers. |
20
-
|**Enabled**| When an application is **disabled**, it no longer accepts new connections and deactivates all associated services. Clients cannot connect, send or receive messages, or use other Ably services. When **enabled**, the application allows new connections and activates all related services. |
20
+
|**Enabled**| When an application is disabled, it no longer accepts new connections and deactivates all associated services. Clients cannot connect, send or receive messages, or use other Ably services. When enabled, the application allows new connections and activates all related services. |
21
21
22
22
### Channel rule configuration
23
23
24
24
The following explains the configuration rules for specific [namespaces](/docs/channels#namespaces) or [channels](/docs/channels):
25
25
26
26
| Section | Description |
27
27
| ------- | ----------- |
28
-
|**Namespace or channel ID**| Identify the specific namespace or channel to which this rule will apply. |
29
-
|**Persist last message**| Stores the last message published on a channel for 365 days, accessible via the rewind mechanism. |
30
-
|**Persist all messages**| Ably stores all messages for two minutes by default. Depending on your account package, this can be increased to 24 or 72 hours. It is also possible to persist the last message sent to a channel for a year. |
31
-
|**Identified**| Requires clients to authenticate with a client ID to interact with channels in this namespace. |
32
-
|**TLS only**| Restricts access to channels within this namespace to clients connected using TLS. |
33
-
|**Push notifications enabled**| Enables publishing messages with a push payload, triggering native push notifications to registered devices. |
34
-
|**Message interactions enabled**| Enables unique time serial fields in messages, enabling typed references between messages (e.g., implementing 'Likes' in a chat). |
35
-
|**Server-side batching enabled**| Batches inbound messages on the server side before sending them to subscribers based on the configured policy. |
36
-
|**Cancel**| Discards changes and closes the dialog without saving the new rule.|
28
+
| Namespace or channel ID | Identify the specific namespace or channel to which this rule will apply. |
29
+
| Persist last message | Stores the last message published on a channel for 365 days, accessible via the rewind mechanism. |
30
+
| Persist all messages | Ably stores all messages for two minutes by default. Depending on your account package, this can be increased to 24 or 72 hours. It is also possible to persist the last message sent to a channel for a year. |
31
+
| Identified | Requires clients to authenticate with a client ID to interact with channels in this namespace. |
32
+
| TLS only | Restricts access to channels within this namespace to clients connected using TLS. |
33
+
| Push notifications enabled | Enables publishing messages with a push payload, triggering native push notifications to registered devices. |
34
+
| Message interactions enabled | Enables unique time serial fields in messages, enabling typed references between messages (e.g., implementing 'Likes' in a chat). |
35
+
| Server-side batching enabled | Batches inbound messages on the server side before sending them to subscribers based on the configured policy. |
36
+
| Cancel | Discards changes and closes the dialog without saving the new rule.|
37
37
38
38
### Protocol adapter settings
39
39
40
40
The following explains the configuration support for various communication protocols ([Pusher](/docs/protocols/pusher), [PubNub](/docs/protocols/pubnub), [MQTT](/docs/protocols/mqtt)), enabling different client libraries to interact with Ably.
41
41
42
42
| Settings | Description |
43
43
| --------- | ----------- |
44
-
|**Pusher protocol support**| Provides compatibility with the Pusher protocol. |
45
-
|**PubNub protocol support**| Provides compatibility with the PubNub protocol. |
46
-
|**MQTT protocol support**| Provides compatibility with the MQTT protocol. |
44
+
| Pusher protocol support | Provides compatibility with the Pusher protocol. |
45
+
| PubNub protocol support | Provides compatibility with the PubNub protocol. |
46
+
| MQTT protocol support | Provides compatibility with the MQTT protocol. |
0 commit comments