Get ticket count by field
GET {{baseUrl}}/api/v1/ticketsCountByFieldValues?field=<String>
This API returns the ticket count of your help desk, filtered by a specific field.
OAuth Scope
Desk.search.READ
Desk.tickets.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
departmentId | string | ID of the department from which ticket count must be fetched. If you do not pass this parameter in the API request, ticket count across all departments will be returned. | |
assigneeId | string | ID of the agent assigned to resolve the ticket | |
contactId | string | ID of the contact who raised the ticket | |
accountId | string | ID of the account to which the ticket is mapped | |
category | string | Category of the ticket | |
customField1 | string | User-defined field in the ticket | |
customField2 | string | User-defined field in the ticket | |
customField3 | string | User-defined field in the ticket | |
createdTimeRange | string | Key that filters tickets created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
modifiedTimeRange | string | Key that filters tickets modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z | |
field | string | Field by which the ticket count must be filtered. Values allowed are. <br>status, <br> <br>priority, <br> <br>channel, <br> <br>statusType, <br> <br>spam, <br> <br>overDue <br> |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"overDue":2,"statusType":[{"count":"13","value":"OPEN"},{"count":"0","value":"ONHOLD"},{"count":"0","value":"CLOSED"}],"channel":[{"count":"6","value":"twitter"},{"count":"3","value":"forums"},{"count":"2","value":"chat"},{"count":"2","value":"web"}],"priority":[{"count":"8","value":"high"},{"count":"5","value":"medium"}],"spam":10,"status":[{"count":"9","value":"open"},{"count":"4","value":"escalated"}]}