Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Pipeline Execution Details on the Dashboard

Updated on 2025-12-16 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Pipeline Execution Details on the Dashboard

Function

This API is used to query the pipeline execution success rate and execution times in each project under a tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/dashboard/executions-overview

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value contains 32 characters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
startTime	Yes	String	Definition: Start time of the query time range. Constraints: N/A Range: The value is a timestamp and does not support the yyyy-MM-dd HH:mm:ss format. Default value: N/A
endTime	Yes	String	Definition: End time of the query time range. Constraints: N/A Range: The value is a timestamp and does not support the yyyy-MM-dd HH:mm:ss format. Default value: N/A
pageNo	No	String	Definition: Page number for pagination query. Constraints: N/A Range: NOTE: 0 Default value: 1
pageSize	No	String	Definition: Page size. Constraints: N/A Value range: NOTE: 0 Default value:
order	No	String	Definition: Sorting order. Constraints: N/A Value range: desc: descending order. asc: ascending order. Default value: This parameter is left empty by default, indicating that items are in arbitrary order.
sort	No	String	Definition: Sorting field. Constraints: N/A Value range: N/A Default value: This parameter is left empty by default, indicating that items are in arbitrary order.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number. Value range: ≥ 0
pageSize	Integer	Definition: Page size. Value range: ≥ 0
pageNo	Integer	Definition: Page number. Value range: ≥ 1
executeSuccessRatio	Integer	Definition: Execution success rate. Value range: 0–100.
executeCount	Integer	Definition: Number of executions. Value range: ≥ 0
projectExecuteList	Array of projectExecuteList objects	Definition: Project execution list. Value range: N/A

**Table 4** projectExecuteList
Parameter	Type	Description
projectName	String	Definition: Project name. Value range: N/A
projectId	String	Definition: Project ID. Value range: 32 characters.
successRatio	Integer	Definition: Success rate. Value range: 0–100.
executeTime	Integer	Definition: Execution time. Value range: ≥ 0
deleted	Boolean	Definition: Whether the item has been deleted. Value range: true: yes false: no

Example Requests

GET https://{endpoint}/v5/e3d7cec9fcd248958fc729f7220f136d/api/dashboard/executions-overview?startTime=1761321600000&endTime=1763999999000&pageNo=1&pageSize=10&_=1763949971018

Example Responses

Status code: 200

{
  "total" : 1,
  "pageSize" : 10,
  "pageNo" : 1,
  "executeSuccessRatio" : 100,
  "executeCount" : 9,
  "projectExecuteList" : [ {
    "projectName" : "Project deleted.",
    "projectId" : "ef196c1f990c4fa6b65b17a2fa601002",
    "successRatio" : 100,
    "executeTime" : 9,
    "deleted" : true
  } ]
}