Devices

Devices are real-world instances of measurement data collection, like that collected by a meter or a gauge.

https://api.validere.io/app

Search devices

Search Devices

post
Body
all ofOptional
and
and
Responses
200

successful operation

application/json
Responseall of
post
POST /app/v1/devices/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "facility.name": "WellSite1"
      }
    ],
    "custom_attributes.hint": "View schema for all supported fields",
    "custom_attributes.operator": "bob",
    "name": {
      "$like": "wind"
    }
  }
}
200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "created_at": "2025-08-19T00:27:52.767Z",
      "updated_at": "2025-08-19T00:27:52.767Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "attributes": {
        "height": 10,
        "location": [
          43.65107,
          -79.347015
        ],
        "provider": "provider"
      },
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      },
      "facility": {
        "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
        "name": "Facility 1"
      },
      "facility_id": "123e4567-e89b-12d3-a456-426614174000",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "measurement_types": [
        "volume"
      ],
      "name": "text",
      "status": "active",
      "type_id": "text"
    }
  ]
}

Get a device

Get a Device by ID

get
Path parameters
device_idstring · uuidRequired

Id of device

Example: 748970de-fd1f-4494-ae3f-47cc21ff205f
Query parameters
periodstringOptional

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Responses
200

successful operation

application/json
get
GET /app/v1/devices/{device_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

successful operation

{
  "description": "text",
  "name": "text",
  "units": "text",
  "value": "text",
  "created_at": "2025-08-19T00:27:52.767Z",
  "updated_at": "2025-08-19T00:27:52.767Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "height": 10,
    "location": [
      43.65107,
      -79.347015
    ],
    "provider": "provider"
  },
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "facility": {
    "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
    "name": "Facility 1"
  },
  "facility_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "measurement_types": [
    "volume"
  ],
  "status": "active",
  "type_id": "text",
  "measurement_series": [
    {
      "description": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "measurement_type": "volume",
      "unit": "bbl"
    }
  ]
}

Last updated