/api/metric

POST /api/metric/dataset

Changed on

Execute a metric or measure-based query and stream the results.

Request body requires a definition object containing:

  • expression: A metric math expression tree (leaf reference or arithmetic) Examples: [:metric {:lib/uuid "a"} 42], [:- {} [:metric {:lib/uuid "a"} 1] [:metric {:lib/uuid "b"} 2]]
  • filters (optional): Per-instance filters keyed by :lib/uuid from the expression
  • projections (optional): Typed projections keyed by source type and ID
post/api/metric/dataset

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

Response

Successful response

row_countinteger required

value must be an integer greater or equal to than zero.

status'completed' | 'completed' required

Changes

    • breaking

      the ///////// request property's minItems was increased to 3

    • breaking

      the ///////// request property's minItems was increased to 3

    • breaking

      removed subschema #2 from the / request property oneOf list

    • breaking

      removed subschema #2 from the / request property oneOf list

    • info

      added subschema #2 to the / request property anyOf list

    • info

      added subschema #2 to the / request property anyOf list

    • info

      endpoint added