Get metric data by asset ID

GET 
/organizations/:organizationId/assets/:assetId/metrics

Get Metric Data By Asset ID for Organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

assetId stringrequired

The ID of asset.

Query Parameters

days numberrequired

Possible values: >= 1 and <= 32

The day of metric.

metricName stringrequired

The name of IoT things.

maxResults number

Possible values: >= 10 and <= 100

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the asset.
timestamp objectrequired
errors object[]required
List of errors (empty if none).
Array [
]

Example (from schema)

{
  "data": {
    "timestamp": {}
  },
  "errors": [
    {}
  ]
}

Example

{
  "data": {
    "1708797600000": {
      "a-24e124148b329013": {
        "Voltage-average": 115.91
      },
      "a-24e124148c480389": {
        "Voltage-average": 248.05
      },
      "a-24e124148c482498": {
        "Voltage-average": 247.21
      }
    }
  },
  "errors": []
}

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