Help Center> CodeArts Deploy> API Reference> APIs> Deployment Record Measurement> Obtaining the Success Rate of Deployed Applications in a Specified Project

Updated on 2023-11-28 GMT+08:00

View PDF

Obtaining the Success Rate of Deployed Applications in a Specified Project

Function

This API is used to obtain the application deployment success rate of a specified project.

URI

GET /v2/{project_id}/metrics/success-rate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start_date	Yes	String	Left boundary (included) of the application deployment start time. The format is yyyy-MM-dd.
end_date	Yes	String	Right boundary (included) of the application deployment start time. The format is yyyy-MM-dd. The maximum time range is one year.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
success_rate	String	Success rate.
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name.
start_date	String	Left boundary (included) of the application deployment start time. The format is yyyy-MM-dd.
end_date	String	Right boundary (included) of the application deployment start time. The format is yyyy-MM-dd.
task_count	Integer	Number of queried applications.
record_count	Integer	Number of queried application deployment records.
success_record_count	Integer	Number of successful application deployment records.

Example Requests

This API is used to obtain the deployment success rate of the target application in a specified period.

https://{endpoint}/v2/89931e210b214b5892ea833712f0f5e0/metrics/success-rate?start_date=2022-01-01&end_date=2022-10-26

Example Responses

Status code: 200

OK: The request is successful.

{
  "success_rate" : "34.09",
  "project_id" : "89931e210b214b5892ea833712f0f5e0",
  "project_name" : "Happy",
  "start_date" : "2022-01-01",
  "end_date" : "2022-10-26",
  "task_count" : 8,
  "record_count" : 44,
  "success_record_count" : 15
}