Remot Open API Docs

Introduction

The Remot Open API allows customers to stream device log data over an HTTP connection.

Getting started

To use this API for the first time, please get in touch with our support team to have it enabled for you. There after, log into your account on the Remot platform; a new menu item labelled "API Tokens" will be available. This is an area for you to manage and create tokens that can be used to retrieve the data we have collected from your device.

Please note the following:

  1. You can create as many tokens as you need.
  2. If you intend to create multiple tokens, it is recommended that you give each of them a meaningful name; preferrable one that identifies which consumer is using the token.
  3. Deleting a token instantly invalidates it; all API consumers using that token will not have access to log data anymore.
  4. Valid tokens grant access to data from all (or only) devices attached to the account that created the token.

Example request

URL Parameters

Field Type Description
device_serial string The serial number of the device in subject

Get Parameters

Field Type Description
from string Start date of the period for which to query the data
to string End date of the period for which to query the data 
curl --location -g --request GET 'https://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{api_token}}'

Response

To preserve performance, the response for any request has been designed to return a maximum of 3000 entries.

The response does contain additional response meta data including links to access the different available pages for the request criteria.

{
    "current_page": 1,
    "data": [
        {
            "id": 57384385,
            "device": 561,
            "supply_voltage": "0.00",
            "supply_current": "0.03",
            "battery_voltage": "1.42",
            "panel_voltage": "2.67",
            "panel_current": "0.00",
            "temp_room": 0,
            "temp_battery": 0,
            "time_stamp": "2019-03-22 20:43:07"
        },
        {
            "id": 57384393,
            "device": 561,
            "supply_voltage": "0.00",
            "supply_current": "0.03",
            "battery_voltage": "1.36",
            "panel_voltage": "2.65",
            "panel_current": "0.00",
            "temp_room": 0,
            "temp_battery": 0,
            "time_stamp": "2019-03-22 20:43:11"
        },
        {
            "id": 57384405,
            "device": 561,
            "supply_voltage": "0.00",
            "supply_current": "0.03",
            "battery_voltage": "1.38",
            "panel_voltage": "2.66",
            "panel_current": "0.00",
            "temp_room": 0,
            "temp_battery": 0,
            "time_stamp": "2019-03-22 20:43:14"
        },
        ...
    ],
    "first_page_url": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14&page=1",
    "from": 1,
    "last_page": 28,
    "last_page_url": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14&page=28",
    "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        ...
        {
            "url": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14&page=28",
            "label": "28",
            "active": false
        },
        {
            "url": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14&page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records?from=2016-06-14&to=2021-06-14&page=2",
    "path": "http://open-api.remotonline.com/api/v1/devices/:device_serial/records",
    "per_page": 3000,
    "prev_page_url": null,
    "to": 3000,
    "total": 83495
}

Please contact our support team in case you notice any unexpected behaviour.