Data -- Queries
Execute Query
Executes a query and returns the result. Accepts a query builder object, a query ID, a query name, or a raw SQL statement.
The format query parameter controls the shape of the data array in the response:
| Value | Description |
|---|---|
| CELL_TYPED (default) | Each cell is an object with name, displayName, dataType, order, and value. |
| SIMPLE | Each row is a flat JSON object whose keys are the column names. |
| COMPACT | Each row is a plain array of values ordered by column position. |
post/data/projects/{projectId}/queries/execute
Request
- Base URL: https://partner.peaka.studio/api/v1
- URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute
- Auth: HTTP bearer
Path parameters
projectIdstring required
ID of the Project
Query parameters
format'CELL_TYPED' | 'SIMPLE' | 'COMPACT'
Response format: CELL_TYPED (default), SIMPLE, or COMPACT
Request body
Response
Query Result
Changes
No recorded changes to this operation across all 1 revision of this API.