Queries the traffic data of a specified instance from the dashboard.
Try it now
Test
RAM authorization
Request syntax
GET /v2/openapi/instances/{instanceId}/dashboard/metrics/flows HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
The instance ID. |
airec-cn-o400whm78004 |
| startTime |
integer |
Yes |
The UNIX timestamp in seconds. |
1586673466 |
| endTime |
integer |
Yes |
The UNIX timestamp in seconds. |
1586673466 |
| metricType |
string |
Yes |
The metric type. USER_ACTION_PV_COUNT: The total number of page views (PVs). USER_ACTION_UV_COUNT: The total number of unique visitors (UVs). USER_ACTION_PV_RATIO: The traffic conversion rate. USER_ACTION_UV_RATIO: The traffic per capita. |
USERACTIONPV_COUNT |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| result |
array<object> |
The statistics. |
|
|
object |
|||
| metricType |
string |
The metric type. |
xxx |
| metricData |
object |
The metric data. |
xxx |
| 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": [
{
"metricType": "xxx",
"metricData": {
"test": "test",
"test2": 1
}
}
],
"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.