대시보드 데이터 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

Dashboard의 API Key 관련 파라미터를 이용하여 대시보드 차트 데이터를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /dashboards/api-keys/{api-key-id}/products/{product-id}/charts

요청 헤더

API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
api-key-id String Required Product에 연결된 API Key ID
product-id String Required API에 연결된 Product ID

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regions List<String> Optional 대시보드 차트 데이터를 조회할 리전
  • 컬렉션의 아이템은 null일 수 없음
offset Long Optional 조회할 데이터 목록에서 시작할 위치
  • 0~9,223,372,036,854,775,807
limit Long Optional 한 번에 조회할 데이터 개수
  • 1~9,223,372,036,854,775,807
from String Required 조회 시작 일자(yyyy-MM-dd)
to String Required 조회 종료 일자(yyyy-MM-dd)
timeZone String Required 타임 존(+09:00)
  • GET 방식 이용 시 URL 인코딩 필요
    		•
    apiId String Optional Product에 생성된 API ID

    요청 예시

    요청 예시는 다음과 같습니다.

    curl -X GET 'https://apigateway.apigw.gov-ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/charts
?from=2024-05-09
&to=2024-05-09
&timeZone=%2B09%3A00' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

    응답

    응답 형식을 설명합니다.

    응답 구문

    구문은 다음과 같습니다.

    {
    "apis": {
        "content": [
            {
                "apiId": "apiId",
                "apiName": "apiName",
                "deleted": false,
                "stages": [
                    {
                        "stageId": "stageId",
                        "stageName": "stageName",
                        "deleted": false,
                        "series": [
                            {
                                "name": "callCount",
                                "region": "region",
                                "data": [
                                    {
                                        "time": "2024-05-09",
                                        "value": 0.0
                                    }
                                ]
                            },
                            {
                                "name": "avgResponseTime",
                                "region": "region",
                                "data": [
                                    {
                                        "time": "2024-05-09",
                                        "value": 0.0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "total": 0
    }
}

    응답 상태 코드

    API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    {
    "apis": {
        "content": [
            {
                "apiId": "*****luwtk",
                "apiName": "api-***",
                "deleted": false,
                "stages": [
                    {
                        "stageId": "*****7mhdv",
                        "stageName": "v1",
                        "deleted": false,
                        "series": [
                            {
                                "name": "callCount",
                                "region": "KR",
                                "data": [
                                    {
                                        "time": "2024-05-09",
                                        "value": 0.0
                                    }
                                ]
                            },
                            {
                                "name": "avgResponseTime",
                                "region": "KR",
                                "data": [
                                    {
                                        "time": "2024-05-09",
                                        "value": 0.0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "total": 1
    }
}