Usage examples
- Print
- PDF
Usage examples
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Usage examples
How to view total online counts
Request
- Method : POST
- URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/subscriptions
GET
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/subscriptions?filter=%7B%22online%22%3Atrue%7D&sort=%7B%22created_at%22%3A%22-1%22%7D&option=%7B%22count%22%3Atrue%7D
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
| Header | Type | Required | Description |
|---|---|---|---|
| X-API-KEY | String | O | Authentication key issued by GAMEPOT |
| X-PROJECT-ID | String | O | Dashboard project ID |
| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | String | O | {"online":true} View users who are currently online |
| sort | String | X | Define the filter for the fields you want to sort |
| option | String | X | {"count":true} Get only the total number |
Response
Success
{
"data": {
"subscriptions": {
"totalCount": 5227,
"edges": null
}
}
}
| Attribute | Type | Description |
|---|---|---|
| totalCount | Number | Project ID |
Failure
{
"status": -1,
"message": "Error message"
}
| Attribute | Type | Description |
|---|---|---|
| code | Int | Result \ (1: success, refer to the error code in case of failure ) |
| error | String | Error message |
Was this article helpful?