POST
/
data
/
projects
/
{projectId}
/
queries
/
execute
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \
  --header 'Content-Type: application/json' \
  --data '{
  "from": [
    {
      "catalogName": "peaka",
      "schemaName": "query",
      "tableName": "samplequery"
    }
  ]
}'
{
  "columns": [
    {
      "catalogId": "2",
      "catalogName": "peaka",
      "schemaName": "query",
      "tableName": "samplequery",
      "columnName": "amount"
    }
  ],
  "data": [
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ]
  ]
}

Path Parameters

​
projectId
string
required

Body

application/json
Execute Query Request
​
columns
string[]
​
from
object[]
​
limit
integer
​
offset
integer
​
orderBy
string[]
​
filters
object

Response

200 - application/json
Query Result

Represents the result of a query.

​
columns
object[]

The columns of the query result.

This class represents a Column. It contains the catalog ID, catalog name, schema name, table name, and column name.

​
data
array

The data of the query result.