ListDashboardMetrics - - Alibaba Cloud Documentation Center

Queries the metrics of a specified instance on the dashboard.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/openapi/instances/{instanceId}/dashboard/metrics

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The type of the metric. Valid values: USER_ACTION_PV_COUNT: the number of page views USER_ACTION_UV_COUNT: the number of unique views USER_ACTION_PV_RATIO: the conversion rate USER_ACTION_UV_RATIO: the traffic consumed per person	airec-cn-o400whm78004
startTime	long	Yes	USERACTIONPV_COUNT	1586673466
endTime	long	Yes	The statistical results.	1586673466
metricType	string	No	The statistical results.	The details about the metric.

Response parameters

Parameter	Type	Description	Example
	object
result	object []	The specific value of the metric.
total	object	The start time. The value is a timestamp in seconds.	xxx
detail	object []	The end time. The value is a timestamp in seconds.
val	string	The error code.	13
startTime	string	The ID of the request.	1586673466
endTime	string	The error message.	1586673466
code	string	null	InternalServerError

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history