View Source

GET/integration/V1/metrics-state/{ticketId}

This endpoint allows viewing the states of all SLA metrics in the given issue.

Parameter	Type	Default value	Required
ticketId	string
showUiMetaData	boolean	false

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039?showUiMetaData=false

Response body:

[
    {
        "slaMetricId": "6729eb08a66f5026ea86fbd1",
        "ticketId": "10039",
        "slaMetricState": "ACTIVE",
        "deadline": "2024-12-05T11:32:19.893+01:00",
        "timeSpent": {
            "millis": 30758956,
            "shortText": "8h 32m 38s"
        },
        "timeRemaining": {
            "millis": -19958956,
            "shortText": "-5h 32m 38s"
        },
        "totalTime": {
            "millis": 10800000,
            "shortText": "3h"
        },
        "isBreached": true,
        "flowingDeadline": false,
        "wasRestarted": false,
        "metricName": "SLA metric 1.0",
        "visible": true
    },
    {
        "slaMetricId": "6751a9af00835a31fb1c27ac",
        "ticketId": "10039",
        "slaMetricState": "ACTIVE",
        "deadline": "2024-12-05T11:32:19.893+01:00",
        "timeSpent": {
            "millis": 30758956,
            "shortText": "8h 32m 38s"
        },
        "timeRemaining": {
            "millis": -19958956,
            "shortText": "-5h 32m 38s"
        },
        "totalTime": {
            "millis": 10800000,
            "shortText": "3h"
        },
        "isBreached": true,
        "flowingDeadline": false,
        "wasRestarted": false,
        "metricName": "Time To Resolution",
        "visible": true
    }
]

GET/integration/V1/metrics-state/{ticketId}/metrics

This endpoint returns metrics related to the given issue.

Parameter	Type	Default value	Required
ticketId	string
showHidden	boolean	false

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039/metrics?showHidden=true

Response body:

[
  {
    "name": "SLA metric 1.0",
    "id": "6729eb08a66f5026ea86fbd1",
    "visible": true
  },
  {
    "name": "Time To Resolution",
    "id": "6751a9af00835a31fb1c27ac",
    "visible": true
  }
]

GET/integration/V1/metrics-state/{ticketId}/{slaMetricId}

Returns the state of the requested SLA metric in the given issue.

Parameter	Type	Default value
ticketId	string
slaMetricId	string
showUiMetaData	boolean	false

Request URL: https://slaapp.almarise.com/integration/V1/metrics-state/10039/6751a9af00835a31fb1c27ac?showUiMetaData=false

Response body:

{
  "slaMetricId": "6751a9af00835a31fb1c27ac",
  "ticketId": "10039",
  "slaMetricState": "ACTIVE",
  "deadline": "2024-12-05T11:32:19.893+01:00",
  "timeSpent": {
    "millis": 32581835,
    "shortText": "9h 3m 1s"
  },
  "timeRemaining": {
    "millis": -21781835,
    "shortText": "-6h 3m 1s"
  },
  "totalTime": {
    "millis": 10800000,
    "shortText": "3h"
  },
  "isBreached": true,
  "flowingDeadline": false,
  "wasRestarted": false,
  "metricName": "Time To Resolution",
  "visible": true
}

Responses

- OK. Returned if the request is successful.

- Unauthorized.

- Forbidden. Returned if the user does not have permission to complete this request.

- Not Found.

- Server Error.