Available in Classic and VPC
View dashboard chart data using the API key-related parameters of the dashboard, and download the results as an Excel file.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /api/v1/dashboards/api-keys/{api-key-id}/products/{product-id}/apis/{api-id}/stages/{stage-id}/export |
Request headers
For information about the headers common to all API Gateway APIs, see API Gateway request headers.
Request path parameters
TYou can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
api-key-id |
String | Required | API key ID associated with the product |
product-id |
String | Required | Product ID associated with the API |
api-id |
String | Required | API ID created on the product |
stage-id |
String | Required | Stage ID created in the API |
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regions |
List[String] | Optional | Region to download dashboard chart data from
|
offset |
Long | Optional | Starting point in the list of data to view
|
limit |
Long | Optional | Number of data to view at once
|
from |
String | Required | Query start date
|
to |
String | Required | Query end date
|
timeZone |
String | Required | Time zone (+09:00)
|
Request example
The following is a sample request.
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys/{api-key-id}/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}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
"Download File"
Response status codes
For information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.