Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
explores
/
{exploreId}
/
compileQuery
cURL
curl --request POST \
  --url http://api/v1/projects/{projectUuid}/explores/{exploreId}/compileQuery \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "hasADateDimension": {
      "name": "<string>",
      "label": "<string>",
      "table": "<string>"
    }
  },
  "timezone": "<string>",
  "metricOverrides": {},
  "customDimensions": [
    {
      "id": "<string>",
      "name": "<string>",
      "table": "<string>",
      "type": "bin",
      "dimensionId": "<string>",
      "binType": "fixed_number",
      "binNumber": 123,
      "binWidth": 123,
      "customRange": [
        {
          "to": 123,
          "from": 123
        }
      ]
    }
  ],
  "additionalMetrics": [
    {
      "label": "<string>",
      "type": "percentile",
      "description": "<string>",
      "sql": "<string>",
      "hidden": true,
      "round": 123,
      "compact": "thousands",
      "format": "km",
      "table": "<string>",
      "name": "<string>",
      "index": 123,
      "filters": [
        {
          "values": [
            "<any>"
          ],
          "operator": "isNull",
          "id": "<string>",
          "target": {
            "fieldRef": "<string>"
          },
          "settings": "<any>",
          "disabled": true,
          "required": true
        }
      ],
      "baseDimensionName": "<string>",
      "uuid": "<string>",
      "percentile": 123,
      "formatOptions": {
        "type": "default",
        "round": 123,
        "separator": "default",
        "currency": "<string>",
        "compact": "thousands",
        "prefix": "<string>",
        "suffix": "<string>",
        "timeInterval": "RAW",
        "custom": "<string>"
      }
    }
  ],
  "tableCalculations": [
    {
      "type": "number",
      "format": {
        "type": "default",
        "round": 123,
        "separator": "default",
        "currency": "<string>",
        "compact": "thousands",
        "prefix": "<string>",
        "suffix": "<string>",
        "timeInterval": "RAW",
        "custom": "<string>"
      },
      "displayName": "<string>",
      "name": "<string>",
      "index": 123,
      "sql": "<string>"
    }
  ],
  "limit": 123,
  "sorts": [
    {
      "nullsFirst": true,
      "descending": true,
      "fieldId": "<string>"
    }
  ],
  "filters": {
    "tableCalculations": {
      "or": [
        "<any>"
      ],
      "id": "<string>"
    },
    "metrics": {
      "or": [
        "<any>"
      ],
      "id": "<string>"
    },
    "dimensions": {
      "or": [
        "<any>"
      ],
      "id": "<string>"
    }
  },
  "metrics": [
    "<string>"
  ],
  "dimensions": [
    "<string>"
  ],
  "exploreName": "<string>",
  "parameters": {}
}
'
{
  "results": {
    "parameterReferences": [
      "<string>"
    ],
    "query": "<string>"
  },
  "status": "ok"
}

Path Parameters

​
exploreId
string
required
​
projectUuid
string
required

Body

application/json
​
tableCalculations
object[]
required
  • Option 1
  • Option 2
​
limit
number
required
​
sorts
object[]
required
​
filters
object
required
​
metrics
string[]
required
​
dimensions
string[]
required
​
exploreName
string
required
​
metadata
object
​
timezone
string
​
metricOverrides
object
​
customDimensions
object[]
  • Option 1
  • Option 2
​
additionalMetrics
object[]
​
parameters
object

Construct a type with a set of properties K of type T

Response

Success

​
results
object
required
​
status
enum<string>
required
Available options:
ok