활용예제
- 인쇄
- 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 | 대시보드 > 설정 > 일반 > API 키 |
| 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 | 오류 내용 |
이 문서가 도움이 되었습니까?