Loading ...

REST API: Get Case Status Statistics | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Get Case Status Statistics
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Case Status Statistics

0 
 /5
0 (0votes)

Get Case Status Statistics

GET /api/cases/stats

Get statistics for a case status in a space. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
SpaceID &SpaceID=x - Used in the request URL as a query parameter

Unique ID of the space.
StatusID &StatusID=x - Used in the request URL as a query parameter

Unique ID of the case status.

Example Request

GET https://myintranet.communifire.com/api/cases/stats?SpaceID=7&StatusID=29

Example Response

Case stats JSON object is returned as ResponseData.


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "IssueStatusID": 29,
      "StatusType": 0,
      "IssueStatusName": "Response Required",
      "SpaceID": 7,
      "IssueStatusNameKey": 0,
      "IssueCount": 11,
      "ProjectID": 0,
      "StatusColorCssClass": "case-status-label-feedbackrequired",
      "TenantID": 1
    }
  ]
}

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software