Preview analytics query

POST/api/analytics/query

Translates a natural-language analytics question into a query preview.

Request Body

application/json

Request payload for Preview analytics query.

query*string

Natural-language analytics question to translate and run.

Example"Show quotes created this week by owner."

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/analytics/query" \  -H "Content-Type: application/json" \  -d '{    "query": "Show quotes created this week by owner."  }'

{
  "query": "select * from quotes where created_at >= current_date - 7"
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Preview analytics query

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`