DescribeUserMetrics - - Alibaba Cloud Documentation Center

Queries user metrics related to the conversion rate.

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}/metrics

Request parameters

Parameter	Type	Required	Description	Example
startTime	long	Yes	The start time. The value is a timestamp in seconds.	1567152000
endTime	long	Yes	The end time. The value is a timestamp in seconds.	1567155600
metricType	string	Yes	The type of the user metric that you want to query. Valid values: pvCtr and uvCtr.	pvCtr
instanceId	string	Yes	The instance ID.	airec-cn-o400whm78004

Response parameters

Parameter	Type	Description	Example
	object
result	object []	The returned results.
sceneId	string	The scene ID.	all
dataPoints	object []	The returned metrics.
val	float	The value of the corresponding metric.	84.6
startTime	long	The start time. The value is a timestamp in seconds.	1567152000
endTime	long	The end time. The value is a timestamp in seconds.	1567152000
code	string	The error code.	InternalServerError
requestId	string	The request ID.	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	The error message.	An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": [
    {
      "sceneId": "all",
      "dataPoints": [
        {
          "val": 84.6,
          "startTime": 1567152000,
          "endTime": 1567152000
        }
      ]
    }
  ],
  "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