compiler

Enumerate all valid query configurations

Enumerate every valid query configuration for a connection.

Generates all valid combinations of optional dimensions, measures, calculations, filters, and variable values, constrained by widget category rules.

RLS: Filtered to current client (ClientRLSDB).

post/api/v1/compiler/enumerate

Query parameters

sourcestring nullable

Headers

X-Kater-CLI-IDstring nullable

Request body

connection_idstring uuid required

Connection to enumerate against

query_idsstring[] nullable

Optional query UUIDs to limit enumeration. If omitted, enumerates all queries.

tenant_keystring required

Tenant key for multi-tenant clients. Use 'kater_global_tenant' for no-tenancy clients or when no tenant isolation is needed.

Response

Successful Response

total_countinteger required

Total number of combinations

Changes

Changed in 3 of the 11 revisions of this API.817

  • 6a140b82e07c212See the full diff
    • the request property tenant_key became required

      request-property-became-required

    • request property tenant_key list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • removed the request property query_refs

      request-property-removed

    • added the new optional request property query_ids

      new-optional-request-property

    • added the optional property combinations/items/query_kater_id to the response with the 200 status

      response-optional-property-added

  • bef1f3e205dd64See the full diff
    • response property errors list-of-types was widened by adding types array to media type application/json of response 400

      response-property-list-of-types-widened

    • response property errors list-of-types was widened by adding types array to media type application/json of response 401

      response-property-list-of-types-widened

    • response property errors list-of-types was widened by adding types array to media type application/json of response 403

      response-property-list-of-types-widened

    • response property errors list-of-types was widened by adding types array to media type application/json of response 404

      response-property-list-of-types-widened

    • response property errors list-of-types was widened by adding types array to media type application/json of response 422

      response-property-list-of-types-widened

    • response property errors list-of-types was widened by adding types array to media type application/json of response 500

      response-property-list-of-types-widened

    • added the new optional request property tenant_key

      new-optional-request-property

    • added the optional property combinations/items/combination_id to the response with the 200 status

      response-optional-property-added

    • added the optional property combinations/items/roles to the response with the 200 status

      response-optional-property-added

    • added the optional property combinations/items/widget_type to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog