View dashboard data
- Print
- PDF
View dashboard data
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View dashboard chart data using the API key-related parameters in the dashboard.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /dashboards/api-keys/{api-key-id}/products/{product-id}/charts |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| 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 |
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
regions | List<String> | Optional | Region to view 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 (yyyy-MM-dd) |
to | String | Required | Query end date (yyyy-MM-dd) |
timeZone | String | Required | Time zone (+09:00) |
apiId | String | Optional | API ID created on the product |
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}/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}'
Response
The following describes the response format.
Response syntax
The syntax is as follows.
{
"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
}
}
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Response example
The following is a sample response.
{
"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
}
}
Was this article helpful?