Logs

Execute a log query and return the requested page of records. Each request is self-contained - there is no server-side query state to open or close.

All column filters are combined with AND; use a filter of type set to combine conditions on the same column with OR. Filter and ordering column names are validated against the log definition.

Numeric filter values for timestamp columns are UNIX timestamps (milliseconds for columns of millisecond resolution). A string value is parsed as a timestamp and accepts ISO 8601, a UNIX timestamp, a relative offset such as -30m, or now.

Records are returned as objects keyed by column name, with values typed according to the column type: coded and integer columns as numbers, timestamps as ISO 8601 strings, everything else as strings. Detail columns are not included.

Paging is implemented by re-executing the query and skipping records, so a large offset is expensive; offset + limit may not exceed 100000.

post/v1/logs/{log-name}/query

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/logs/{log-name}/query
  • Auth
    HTTP bearer

Request body

offsetinteger

Number of records to skip

limitinteger

Maximum number of records to return (1 to 10000; offset + limit may not exceed 100000)

Response

Query executed successfully

offsetinteger

Number of records skipped

countinteger

Number of records returned

recordsobject[]

Log records as objects keyed by column name

Changes

    • warning

      added the new Room enum value to the /// response property for the response status

    • warning

      added the new CoolingZone enum value to the /// response property for the response status

    • warning

      added the new Facility enum value to the /// response property for the response status

    • warning

      added the new PowerDomain enum value to the /// response property for the response status