Skip to main content
GET
/
data
/
projects
/
{projectId}
/
queries
/
{queryId}
Read Query
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/{queryId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "displayName": "<string>",
  "name": "<string>",
  "inputQuery": "<string>",
  "inputQueryRefId": "<string>",
  "queryType": "<string>",
  "schedule": {
    "expression": "<string>"
  },
  "path": "<string>",
  "folderId": "<string>"
}

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
​
queryId
string
required

Response

200 - application/json

Read Query

​
id
string

The ID of the query.

​
displayName
string

The display name of the query.

​
name
string

The name of the query.

This is the name of the query which will be used in the sql query. e.g. SELECT * FROM "peaka"."query".""

​
inputQuery
string

The sql query.

​
inputQueryRefId
string

The reference id of the input query.

​
queryType
string

The type of the query: PLAIN or MATERIALIZED

​
schedule
object

This class represents a schedule for a materialized query.

​
path
string

The path of the query (e.g. "/analytics/dashboards"). Null if the query is not in any folder.

​
folderId
string

The ID of the folder containing this query. Null if the query is not in any folder.