PULSAR

Get Machine Metrics

Get a single machine metrics, identified by machineId and metricType.

Authorization

bearerAuth user, superuser, admin, superadmin, readonly
Authorization<token>

In: header

Scope: user, superuser, admin, superadmin, readonly

Path Parameters

machineId*number

The machine's ID.

Formatdouble
metricType*string

The metric type.

Value in

  • "speed"
  • "oee"
  • "quality"
  • "uptime"
  • "downtime"
  • "availability"
  • "performance"
  • "correct"
  • "defects"
  • "total"

Query Parameters

interval*string

Filter by interval.

Value in

  • "shift"
  • "daily"
  • "weekly"
  • "monthly"
start*string

The start of the date range to filter by.

Formatdate-time
end*string

The end of the date range to filter by.

Formatdate-time
aggregation?string

Filter by aggregation.

Value in

  • "average"
  • "count"
  • "max"
  • "min"
  • "sum"

Response Body

application/json

Try it live
GET
/machines/{machineId}/metrics/{metricType}

This endpoint requires authentication — use the Login page at the top of the API Reference, or paste a token in the Authorization section below.

curl -X GET "https://example.com/machines/0.1/metrics/speed?interval=shift&start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[  {    "metric": "speed",    "value": 0,    "timestamp": "2019-08-24T14:15:22Z"  }]