Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ Case 2.0/ Interface of a Single UPS/ Querying Case Overview Statistics
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Case Overview Statistics

Description

This interface is used to query case overview statistics by criteria. The query results can be filtered by start time and end time, and can be displayed in descending order by time. By default, a maximum of 100 records can be displayed on one page in pagination mode.

Method

POST

URI

https://Domain name/service/AICC__Case/1.0.0/openapi/statistics/case/current (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Parameters in the request header

No.

Parameter

Value Type

Mandatory

Description

1

Content-Type

String

Yes

Request body type, which is JSON.

2

access-token

String

Yes

Token for a user to access a tenant space. For details, see 2.
Table 2 Parameters in the request body

No.

Parameter

Value Type

Length (Bytes)

Mandatory

Description

1

caseTypeId

Varchar

20

No

Case type ID

2

startTime

Varchar

11

No

Start time

3

endTime

Varchar

11

No

End time

4

start

Number

11

Yes

Start row number (minimum value: 0)

5

limit

Number

3

Yes

Number of rows to be returned in this query

Value range: 1–100

Response Description

  • Status code: 200
Table 3 Parameters in the response body

No.

Parameter

Value Type

Mandatory

Description

1

caseStatisticsList

CaseStatisticsList []

Yes

Case statistics

2

count

Number

Yes

Total number of records that meet conditions
Table 4 caseStatisticsList parameters

No.

Parameter

Value Type

Mandatory

Description

1

date

Date

Yes

Date

2

caseType

Varchar

No

Case type

3

caseTypeName

Varchar

No

Type name

4

newCases

Number

Yes

Number of new cases

5

finishedCases

Number

Yes

Number of completed cases

6

unfinishedCases

Number

Yes

Number of pending cases

7

averageDuration

Number

Yes

Average processing duration, in days

8

overCases

Number

Yes

Number of overdue cases

Example

Scenario: Query case overview statistics.

URL: https://Domain name/AICC__Case/1.0.0/openapi/statistics/case/report

  • Request header 
    {
 "Content-Type": "application/json",
 "access-token": "0000000000************7bm63KsRmEztTvyA="
}
  • Request body 
    {"start":0,"limit":10,"startTime":"2024-09-20","endTime":"2024-10-20"}
  • Response header 
    { "connection": "keep-alive",
 "Content-Length": "16",
"Content-Type": "application/json%3Bcharset=UTF-8"}
  • Response parameters 
    {"resCode": "0","resMsg": "Success","result": [{ "caseStatisticsList": [{ "averageDuration": 4, "date": "2024-10-03", "finishedCases": 2,"newCases": 1, "overCases": 5, "unfinishedCases": 3 }, { "averageDuration": 44, "date": "2024-10-02", "finishedCases": 22, "newCases": 44, "overCases": 55, "unfinishedCases": 33  }, {  "averageDuration": 55, "date": "2024-10-01", "finishedCases": 23, "newCases": 12,  "overCases": 656, "unfinishedCases": 45 }
  ], "count": 3  } ]}