Get Asset Metrics.

POST 
/organizations/:organizationId/statistics/assets/metrics

Get Asset 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 [
assetId stringrequired
properties objectrequired
key stringrequired
aggregation stringrequired
alias string
]

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the metrics statistic.
startTime numberrequired
endTime numberrequired
period numberrequired
metrics object[]required
Array [
assetId stringrequired
properties object[]required
Array [
key stringrequired
aggregation stringrequired
alias string
]
]

Example (from schema)

{
  "data": {
    "startTime": 0,
    "endTime": 0,
    "period": 0,
    "metrics": [
      {
        "assetId": "string",
        "properties": [
          {
            "key": "string",
            "aggregation": "string",
            "alias": "string"
          }
        ]
      }
    ]
  }
}

Example

{
  "data": {
    "startTime": 1700000000000,
    "endTime": 1800000000000,
    "period": 300,
    "metrics": [
      {
        "assetId": "a-assetId",
        "properties": [
          {
            "key": "Temperature",
            "aggregation": "average",
            "alias": "Temperature"
          }
        ]
      }
    ]
  }
}

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