Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Total Number of Pipelines on the Dashboard

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

Online Debugging

CLI Examples

View PDF

Querying Total Number of Pipelines on the Dashboard

Function

This API is used to query the number of pipelines in each project and the total number of pipelines of the tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/dashboard/pipeline-count

**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
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.
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:

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
projectCountList	Array of projectCountList objects	Definition: Project quantity list. Value range: N/A
allCount	Integer	Definition: Total count. Value range: ≥ 0

**Table 4** projectCountList
Parameter	Type	Description
projectName	String	Definition: Project name. Value range: N/A
projectId	String	Definition: Project ID. Value range: 32 characters.
pipelineCount	String	Definition: Number of pipelines. Value range: Number represented by string.
deleted	Boolean	Definition: Whether the item has been deleted. Value range: true: yes false: no

Example Requests

GET https://{endpoint}/v5/e3d7cec9fcd248958fc729f7220f136d/api/dashboard/pipeline-count?pageNo=1&pageSize=10&_=1763949971018

Example Responses

Status code: 200

{
  "total" : 2,
  "pageSize" : 10,
  "pageNo" : 1,
  "projectCountList" : [ {
    "projectName" : "Test",
    "projectId" : "0187f1f990ce4145b7875b56c00bd860",
    "pipelineCount" : "3",
    "deleted" : false
  }, {
    "projectName" : "Scrum",
    "projectId" : "03a8d331b34345069b509b41a592964c",
    "pipelineCount" : "2",
    "deleted" : false
  } ],
  "allCount" : 2
}