List Materialized Query Statuses - Peaka

List Materialized Query Statuses

curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "queryId": "709922802836177297",
    "queryName": "samplequery",
    "scheduleSettings": {
      "cronExpression": null,
      "repeatDuration": "PT6H",
      "timezone": null,
      "type": "interval"
    },
    "nextExecutionStartTime": "2025-01-15T16:00:00Z",
    "status": "COMPLETED",
    "lastExecutionStartTime": "2025-01-15T10:00:00Z",
    "lastUpdateTime": "2025-01-15T10:05:00Z"
  }
]

GET

/

data

/

projects

/

{projectId}

/

materialized-queries

/

status

List Materialized Query Statuses

curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/data/projects/{projectId}/materialized-queries/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "queryId": "709922802836177297",
    "queryName": "samplequery",
    "scheduleSettings": {
      "cronExpression": null,
      "repeatDuration": "PT6H",
      "timezone": null,
      "type": "interval"
    },
    "nextExecutionStartTime": "2025-01-15T16:00:00Z",
    "status": "COMPLETED",
    "lastExecutionStartTime": "2025-01-15T10:00:00Z",
    "lastUpdateTime": "2025-01-15T10:05:00Z"
  }
]

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

ID of the Project

Response

200 - application/json

List of materialized query statuses

queryId

string

ID of the query

Example:

"709922802836177297"

queryName

string

Name of the query

Example:

"samplequery"

scheduleSettings

object | null

Schedule configuration of a materialized query. Provide EITHER an interval schedule (type=interval with repeatDuration) OR a cron schedule (type=cron with cronExpression and optional timezone). Use type=none for no schedule. The fields that do not apply to the chosen type are omitted.

Show child attributes

Example:

{
  "type": "cron",
  "cronExpression": "0 0 * * *",
  "timezone": "UTC"
}

nextExecutionStartTime

string | null

Next scheduled execution start time (ISO 8601). Null when the schedule type is 'none' or cannot be computed.

Example:

"2025-01-15T16:00:00Z"

status

string

Status of the most recent refresh

Example:

"COMPLETED"

lastExecutionStartTime

string | null

Start time of the last refresh (ISO 8601)

Example:

"2025-01-15T10:00:00Z"

lastUpdateTime

string | null

Time the status was last updated (ISO 8601)

Example:

"2025-01-15T10:05:00Z"