Retrieves sensor data for the given sensor and asset IDs.

get

https://sensor.api.eu1.scalar.zf.com/v1/sensors/history

Retrieves sensor data for specified interval for given sensorIds and assetIds.

📘
The rate limit for this API is normal.

Query Params

sensorIds

array of strings

required

Represents a list of sensor IDs to be retrieved. The latest sensor data with sensorId in the list is retrieved. The input is in comma-delimited format. Maximum 10 sensors are allowed.

The example values are "fuel,mileage,position".

sensorIds*

assetIds

array of uuids

Represents a list of asset IDs to be retrieved. Sensor data for the assets are retrieved. The input is in comma-delimited format.

Maximum 10 assets can be provided. If not provided, all assets for an organization are considered.

assetIds

registeredOnStart

date-time

required

Represents the start time of date range to retrieve in UTC format.

registeredOnEnd

date-time

required

Represents the end time of date range to retrieve in UTC format.

Maximum interval is one week.

limit

int32

Defaults to 500

Optional parameter to represent the limit of total sensor data to be fetched. The default value is 500 and maximum limit is 2000.

after

string

Represents the base64 converted token to be used as a cursor for fetching next batch of sensor data.

Responses

400

Failure code. The request was unacceptable due to the following reasons.

            1. The interval is more than 1 week.
            2. The sensorId count is greater than 10 or empty.
            3. The allowed assetId count is 10, if provided.

Language

Credentials

http

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success code. Retrieves a list of historical sensor data for given date range and filtering parameters.

400Failure code. The request was unacceptable due to the following reasons. 1. The interval is more than 1 week. 2. The sensorId count is greater than 10 or empty. 3. The allowed assetId count is 10, if provided.

401Failure code. Unauthorized access.

403Failure code. Forbidden access.

429Failure code. Too many incoming requests.

500Failure code. Indicates an internal server error (unhandled exception).