Get Work Order Metrics.

POST 
/organizations/:organizationId/statistics/work-orders/metrics

Get Work Order Metrics

Request

Path Parameters

organizationId stringrequired

The ID of organization.

application/json

Body

required

startTime numberrequired

The startTime of metrics statistic.

endTime numberrequired

The endTime of metrics statistic.

period numberrequired

The period of metrics statistic.

metrics object[]required
The metrics of statistic.
Array [
locationId stringrequired
statuses string[]required
priorities string[]required
aggregation stringrequired
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the metrics statistic.
locationId objectrequired
timestamps number[]required
values number[]required

Example (from schema)

{
  "data": {
    "locationId": {
      "timestamps": [
        0
      ],
      "values": [
        0
      ]
    }
  }
}

Example

{
  "data": {
    "l-locationId": {
      "timestamps": [
        1727193600000
      ],
      "values": [
        5
      ]
    }
  }
}

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."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

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

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

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

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...