Get Organization SLA Metrics

GET 
/organizations/:organizationId/sla-metrics

Get aggregated SLA compliance metrics for an organization

Request

Path Parameters

organizationId stringrequired

Organization unique identifier

Query Parameters

startDate string

Start date (ISO 8601). Defaults to 30 days ago.

endDate string

End date (ISO 8601). Defaults to today.

Responses

200

application/json

Schema

Schema

startDate stringrequired

Start date of metrics period (ISO 8601)

endDate stringrequired

End date of metrics period (ISO 8601)

response objectrequired
Response SLA metrics
total numberrequired
onTime numberrequired
overdue numberrequired
percentage numberrequired
resolution objectrequired
Resolution SLA metrics
total numberrequired
onTime numberrequired
overdue numberrequired
percentage numberrequired
byPriority objectrequired
Priority-level breakdown
0 objectrequired
1 objectrequired
2 objectrequired
3 objectrequired

Example (from schema)

{
  "startDate": "string",
  "endDate": "string",
  "response": {
    "total": 0,
    "onTime": 0,
    "overdue": 0,
    "percentage": 0
  },
  "resolution": {
    "total": 0,
    "onTime": 0,
    "overdue": 0,
    "percentage": 0
  },
  "byPriority": {
    "0": {},
    "1": {},
    "2": {},
    "3": {}
  }
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

Loading...