Queries the dashboard metrics for a specified instance.
Try it now
Test
RAM authorization
Request syntax
GET /v2/openapi/instances/{instanceId}/dashboard/metrics HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
airec-cn-o400whm78004 |
| startTime |
integer |
Yes |
The start time. This is a UNIX timestamp in seconds. |
1586673466 |
| endTime |
integer |
Yes |
The end time. This is a UNIX timestamp in seconds. |
1586673466 |
| metricType |
string |
No |
The metric type. Valid values: USER_ACTION_PV_COUNT: Total page views (PVs). USER_ACTION_UV_COUNT: Total unique visitors (UVs). USER_ACTION_PV_RATIO: Traffic conversion rate. USER_ACTION_UV_RATIO: Per capita traffic. |
指标类型 USERACTIONPV_COUNT |
| metricView |
string |
No |
The dimension of the query. This parameter is used with `metricQuery`. The default value is `USER`. Valid values are `USER` (the user dimension) and `ITEM` (the item dimension). |
ITEM |
| metricQuery |
string |
No |
The query condition. The format is k1:v1;k2:v2. |
dimension:ITEM_TYPE;behaviorType:expose |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| result |
array<object> |
The statistical results. |
|
|
object |
|||
| total |
object |
The summary of statistics. |
xxx |
| detail |
array<object> |
The details. |
|
|
object |
|||
| val |
string |
The specific value. |
13 |
| startTime |
string |
A UNIX timestamp in seconds. |
1586673466 |
| endTime |
string |
A UNIX timestamp in seconds. |
1586673466 |
| code |
string |
The error code. |
InternalServerError |
| requestId |
string |
The request ID. |
8F81A922-6C81-46D6-B78C-CC35E16B1691 |
| message |
string |
The error details. |
An internal server error occurred |
Examples
Success response
JSON format
{
"result": [
{
"total": {
"test": "test",
"test2": 1
},
"detail": [
{
"val": "13",
"startTime": "1586673466",
"endTime": "1586673466"
}
]
}
],
"code": "InternalServerError",
"requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
"message": "An internal server error occurred"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.