API Documentation
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Execute Query
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
Body
application/json
Execute Query Request
Response
200 - application/json
Query Result
Represents the result of a query.
The columns of the query result.
The data of the query result.
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
}
]
]
}