• English

      • nb api resource query

      Run aggregate queries against a selected resource. --measures, --dimensions, and --orders all use JSON array format.

      Usage

      nb api resource query --resource <resource> [flags]

      Parameters

      ParameterTypeDescription
      --resourcestringResource name, required
      --data-sourcestringData source key, default main
      --measuresstringMeasure definitions as a JSON array
      --dimensionsstringDimension definitions as a JSON array
      --ordersstringSort definitions as a JSON array
      --filterstringFilter conditions as a JSON object
      --havingstringPost-aggregation filter conditions as a JSON object
      --limitintegerMaximum number of rows to return
      --offsetintegerNumber of rows to skip
      --timezonestringTimezone used for query formatting

      Also supports common connection parameters from nb api resource.

      Examples

      nb api resource query --resource orders --measures '[{"field":["id"],"aggregation":"count","alias":"count"}]'
nb api resource query --resource orders --dimensions '[{"field":["status"],"alias":"status"}]' --orders '[{"field":["createdAt"],"order":"desc"}]'