Skip to main content
POST
/
data
/
projects
/
{projectId}
/
queries
/
execute
curl --request POST \ --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \ --header 'Authorization: Bearer <token>' \ --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
      }
    ]
  ]
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

Body

application/json

Execute Query Request

​
columns
string[]
​
from
object[]
​
limit
integer<int64>
​
offset
integer<int64>
​
orderBy
string[]
​
filters
object

Response

200 - application/json

Query Result

Represents the result of a query.

​
columns
object[]

The columns of the query result.

​
data
object[][]

The data of the query result.