Querying Data Details of a Specified API Dashboard

Function

This API is used to query details about a specified API dashboard.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/service/statistic/apis-dashboards/{api_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
api_id	Yes	String	API ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	Cluster ID
start_time	Yes	Long	Start time (13-digit timestamp).
end_time	Yes	Long	End time (13-digit timestamp).
time_unit	Yes	String	Time unit Enumerated values: HOUR: hour DAY: day

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
Dlm-Type	No	String	Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.
Content-Type	Yes	String	Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
dashboards	Array of StatisticForDashboard objects	Statistics dashboard.

**Table 5** StatisticForDashboard
Parameter	Type	Description
log_time	Integer	Statistical time point (13-bit timestamp).
call_num	Integer	Total number of invoking times.
success_num	Integer	Number of successful invoking times (data obtaining success).
fail_num	Integer	Number of failed invoking times (data obtaining failure).
legal_num	Integer	Number of valid invoking times (pass the verification).
illegal_num	Integer	Invalid invoking volume (failed to pass the verification).
cost_time_avg	Number	Average request duration.
success_cost_time_avg	Number	Average duration of successful requests.
fail_cost_time_avg	Number	Average duration of failed requests.
success_rate	Number	Success rate.
fail_rate	Number	Indicates the failure rate.
legal_rate	Number	Legality rate.
illegal_rate	Number	Illegal rate.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Query details about a specified API dashboard.

/v1/0833a5737480d53b2f250010d01a7b88/service/statistic/apis-dashboards/760715eb1bfce0c575abab3be3bd41e6

Example Responses

Status code: 200

The data details of the specified API dashboard are queried successfully.

{
  "dashboards" : [ {
    "log_time" : 1629403200000,
    "call_num" : 0,
    "success_num" : 0,
    "fail_num" : 0,
    "legal_num" : 0,
    "illegal_num" : 0,
    "cost_time_avg" : 0,
    "success_cost_time_avg" : 0,
    "fail_cost_time_avg" : 0,
    "success_rate" : 0,
    "fail_rate" : 0,
    "legal_rate" : 0,
    "illegal_rate" : 0
  } ]
}