活用例
- 印刷する
- PDF
活用例
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
使用例
オンライン状態の総数の照会方法
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 | GAMEPOTで発行する認証キー |
| X-PROJECT-ID | String | O | ダッシュボードプロジェクト ID |
| パラメータ | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| filter | String | O | {"online":true} 現在オンライン状態のユーザーを照会 |
| sort | String | X | ソートしようとするフィールドのフィルタを定義します。 |
| option | String | X | {"count":true} 総数だけ取得します。 |
Response
成功
{
"data": {
"subscriptions": {
"totalCount": 5227,
"edges": null
}
}
}
| Attribute | Type | Description |
|---|---|---|
| totalCount | Number | プロジェクト ID |
失敗
{
"status": -1,
"message": "エラーメッセージ"
}
| Attribute | Type | Description |
|---|---|---|
| code | Int | 結果値 (1: 成功、失敗時 Error code参照) |
| error | String | エラー内容 |
この記事は役に立ちましたか?