Run Data For Visualisation

POST /dashboards/data-sources/run-query

Run Data For Visualisation

cURL

curl --request POST \
  --url https://api.example.com/dashboards/data-sources/run-query/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "visualisation": {
    "uid": "<string>",
    "title": "<string>",
    "grid_layout": {
      "x": 123,
      "y": 123,
      "w": 123,
      "h": 123
    },
    "data_source_uid": "<string>",
    "config": {
      "columns": [
        "<string>"
      ],
      "type": "STANDARD_TABLE"
    }
  },
  "data_source": {
    "uid": "<string>",
    "query": "<string>",
    "filters": [
      {
        "uid": "<string>",
        "column": "<string>",
        "column_type": "BOOLEAN",
        "filter_condition": {
          "operator": "EQUALS",
          "value": "<string>",
          "is_negated": false
        }
      }
    ]
  },
  "embedding_search": {
    "search_term": "<string>",
    "keyword_column": "",
    "top_k": 1000
  }
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key · string | null

Body

application/json

visualisation · DashboardVisualisationCreate · object · required

Show child attributes

data_source · DashboardDataSourceCreate · object · required

Show child attributes

embedding_search · EmbeddingSearchParams · object

Show child attributes

Response

200

application/json

Successful Response