latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

records

Search and list records

post/app/v1/records/search

Query parameters

asset_detailstring

set to true to include asset detail when group by <asset_type>.id

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_bystring

any field from group_by param

sort_direction'asc' | 'desc'

sort direction

group_bystring[]

Example request

{
  "page_size": 20,
  "sort_direction": "desc",
  "filter": {
    "flow.custom_attributes": {
      "attribute1": 12345,
      "attribute2": "value1"
    },
    "reporting_group_id": "subpartw"
  },
  "group_by": [
    "year_month"
  ]
}

Response

A successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "values": [
        {
          "value": 0.22,
          "configuration": {
            "Interval": "1day"
          }
        }
      ]
    }
  ]
}