Classic/VPC 환경에서 이용 가능합니다.
Dashboard의 Product 관련 파라미터를 이용하여 대시보드 차트 데이터를 조회하고, 그 결과를 엑셀 파일로 다운로드합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v1/dashboards/products/{product-id}/apis/{api-id}/stages/{stage-id}/export |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 정보는 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
product-id |
String | Required | API에 연결된 Product ID |
api-id |
String | Required | Product에 생성된 API ID |
stage-id |
String | Required | API에 생성된 Stage ID |
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
regions |
List[String] | Optional | 대시보드 차트 데이터를 다운로드할 리전
|
offset |
Long | Optional | 조회할 데이터 목록에서 시작할 위치
|
limit |
Long | Optional | 한 번에 조회할 데이터 개수
|
from |
String | Required | 조회 시작 일자
|
to |
String | Required | 조회 종료 일자
|
timeZone |
String | Required | 타임 존(+09:00)
|
요청 예시
요청 예시는 다음과 같습니다.
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/apis/{api-id}/stages/{stage-id}/export?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}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
"Download File"
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 API Gateway 응답 상태 코드를 참조해 주십시오.