Skip to main content
GET
/
data
/
projects
/
{projectId}
/
queries
List Queries
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "709891320440684892",
    "displayName": "sample2",
    "name": "sample2",
    "inputQuery": "",
    "path": "/reports/monthly",
    "folderId": "f_3np1a"
  },
  {
    "id": "702142445051183684",
    "displayName": "deneme",
    "name": "deneme",
    "inputQuery": "SELECT count(*) from \"examplestripecatalogname\".\"payment\".\"customers\""
  },
  {
    "id": "709891051854233848",
    "displayName": "sample",
    "name": "sample",
    "inputQuery": "",
    "path": "/reports/monthly",
    "folderId": "f_3np1a"
  },
  {
    "id": "709922802836177297",
    "displayName": "sampleQuery",
    "name": "samplequery",
    "inputQuery": "SELECT * from \"mycatalog\".payment.charges"
  }
]

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

Response

200 - application/json

Query created

​
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.