Search API documentation version v1

https://api.environet.io

Create token

Use https://environet.io/index.html#all/api to create new token

Examples

  • Get all nodes available for account

    curl -X POST
-H "Accept: application/json" \
-H "Authorization: Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9" \
-H "Content-Type: application/json" \
'https://api.environet.io/search/nodes'

  • Get specific node with data_points

    curl -X POST -d '{"node_id":"5891c430a5b26b128fd81886", "includes":"data_points" }' \
-H "Accept: application/json" \
-H "Authorization: Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9" \
-H "Content-Type: application/json" \
'https://api.environet.io/search/nodes'

  • Get last (10) measurements for all data_points by node_id

    curl -X POST -d '{"node_id":"5891c430a5b26b128fd81886", "last": 10 }' \
-H "Accept: application/json" \
-H "Authorization: Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9" \
-H "Content-Type: application/json" \
'https://api.environet.io/search/nodes'

  • Get measurements for specific data_point by timerange (2017-01-01T00:00:00 2017-02-01T00:00:00)

    curl -X POST -d '{"data_point_id":"5891c430a5b26b128fd81b97", "from": 1483228800000, "to": 1485907200000 }' \
-H "Accept: application/json" \
-H "Authorization: Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9"\
-H "Content-Type: application/json"\
'https://api.environet.io/search/measurements'

/search/nodes

Nodes

post

post

Get a list of nodes.

Get a list of nodes.

Secured by token

Body

Media type: application/json

Type: object

Properties
  • node_id: (array of ID)

    Array of node_ids

    Example:

    [
  "5891c430a5b26b128fd81886"
]
  • data_point_id: (array of ID)

    Array of data_point_ids

    Example:

    [
  "5891c430a5b26b128fd81b97"
]
  • from: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724600000
  • to: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724800000
  • last: (integer - maximum: 100)

    Amount of last measurements to show

  • includes: (one of data_points, null)

    To include data_points without any measurements

    Example:

    data_points

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
  {
    "_id": "5891c430a5b26b128fd81886",
    "serial": "0B825891",
    "name": "Piest L-9080",
    "description": "White Oak South of Columbia Pike (CT)",
    "_type": "thiamis",
    "status": "activated",
    "actions": [
      "configure",
      "deactivate",
      "delete",
      "hibernate",
      "lease",
      "list",
      "read",
      "share"
    ],
    "organization_id": "568a43c3acef4a8715000000",
    "devices": [
      {
        "_id": "0B825891:183",
        "name": "DustTrak",
        "connection": "0B825891.RS232(C).ASCII",
        "tag": "RS232(C)"
      },
      {
        "_id": "0B825891:104",
        "name": "RAE",
        "connection": "0B825891.RS232(A).ASCII",
        "tag": "RS232(A)"
      },
      {
        "_id": "0B825891:0",
        "name": "Thiamis-1000",
        "connection": "0B825891",
        "tag": null
      }
    ],
    "data_points": [
      {
        "_id": "5891c430a5b26b128fd81b96",
        "device_id": "0B825891:183",
        "path": "0B825891:183:2",
        "node_id": "5891c430a5b26b128fd81886",
        "name": "PM1",
        "unit": "mg/m³",
        "round": 3,
        "measurements": [
          [
            1486979580000,
            0.3638
          ]
        ]
      },
      {
        "_id": "5891c430a5b26b128fd81b9a",
        "device_id": "0B825891:183",
        "path": "0B825891:183:6",
        "node_id": "5891c430a5b26b128fd81886",
        "name": "Mass Conc. Total",
        "unit": "mg/m³",
        "round": 3,
        "measurements": [
          [
            1486979580000,
            0.3812
          ]
        ]
      },
      {
        "_id": "5891c430a5b26b128fd81bb2",
        "device_id": "0B825891:0",
        "path": "0B825891:0:8",
        "node_id": "5891c430a5b26b128fd81886",
        "name": "Location",
        "_type": "location",
        "measurements": [
          [
            1486979580000,
            [
              40.6175673160943,
              -73.66616
            ]
          ]
        ]
      }
    ]
  },
  {
    "_id":"56e19e54830f7843befc20cb",
    "_type":"alert",
    "name":"PM ALERT",
    "description":"PM1 values > 0.01",
    "notification_level":"info",
    "attached_nodes":["5891c430a5b26b128fd81886"],
    "conditions":{"and":[{"gt":["DustTrak.2",0.01]}]},
    "actions":["configure","delete","list","read"],
    "organization_id":"568a43c3acef4a8715000000",
    "data_points":[
      {
        "_id":"581247b8e67464eff1a52d5b",
        "attached_node":"5891c430a5b26b128fd81886",
        "node_id":"56e19e54830f7843befc20cb",
        "backend":"unique",
        "linked_data_points":["5891c430a5b26b128fd81b96"],
        "measurements":[
          [1472501870000,true],
          [1474964925000,false],
          [1479309380000,true]
        ]
      }
    ]
  }
]

Secured by token

Headers

  • Authorization: required (string)

    Send this header with the secret token

    Example:

    Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9

/search/data_points

Data points

post

post

Get a list of data points.

Get a list of data points.

Secured by token

Body

Media type: application/json

Type: object

Properties
  • node_id: (array of ID)

    Array of node_ids

    Example:

    [
  "5891c430a5b26b128fd81886"
]
  • data_point_id: (array of ID)

    Array of data_point_ids

    Example:

    [
  "5891c430a5b26b128fd81b97"
]
  • from: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724600000
  • to: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724800000
  • last: (integer - maximum: 100)

    Amount of last measurements to show

  • includes: (one of data_points, null)

    To include data_points without any measurements

    Example:

    data_points

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
  {
    "_id": "5891c430a5b26b128fd81b97",
    "device_id": "0B825891:183",
    "path": "0B825891:183:3",
    "node_id": "5891c430a5b26b128fd81886",
    "name": "PM2.5",
    "unit": "mg/m³",
    "round": 3,
    "measurements": [
      [
        1486977840000,
        0.3658
      ]
    ]
  },
  {
    "_id": "5891c430a5b26b128fd81b98",
    "device_id": "0B825891:183",
    "path": "0B825891:183:4",
    "node_id": "5891c430a5b26b128fd81886",
    "name": "PM4",
    "unit": "mg/m³",
    "round": 3,
    "measurements": [
      [
        1486977840000,
        0.3791
      ]
    ]
  },
  {
    "_id": "5891c430a5b26b128fd81b99",
    "device_id": "0B825891:183",
    "path": "0B825891:183:5",
    "node_id": "5891c430a5b26b128fd81886",
    "name": "PM10",
    "unit": "mg/m³",
    "round": 3,
    "measurements": [
      [
        1486977840000,
        0.3836
      ]
    ]
  }
]

Secured by token

Headers

  • Authorization: required (string)

    Send this header with the secret token

    Example:

    Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9

/search/measurements

Measurements

post

post

Get a list of measurements.

Get a list of measurements.

Secured by token

Body

Media type: application/json

Type: object

Properties
  • node_id: (array of ID)

    Array of node_ids

    Example:

    [
  "5891c430a5b26b128fd81886"
]
  • data_point_id: (array of ID)

    Array of data_point_ids

    Example:

    [
  "5891c430a5b26b128fd81b97"
]
  • from: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724600000
  • to: (integer - minimum: 0 - maximum: 1577836800000)

    Timestamp in milliseconds

    Example:

    1486724800000
  • last: (integer - maximum: 100)

    Amount of last measurements to show

  • includes: (one of data_points, null)

    To include data_points without any measurements

    Example:

    data_points

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "5891c430a5b26b128fd81b96": [
    [
      1486979940000,
      0.3779
    ],
    [
      1486979945000,
      0.3722
    ],
    [
      1486979950000,
      0.3783
    ],
    [
      1486979960000,
      0.3831
    ]
  ],
  "5891c430a5b26b128fd81b9a": [
    [
      1486979940000,
      0.3935
    ],
    [
      1486979945000,
      0.3888
    ],
    [
      1486979955000,
      0.3961
    ],
    [
      1486979960000,
      0.4007
    ]
  ]
}

Secured by token

Headers

  • Authorization: required (string)

    Send this header with the secret token

    Example:

    Bearer 99a9d8d2-e4ee-4146-a015-cf0cf4d345f9