Get Cache Status

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

import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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

{
  "id": "<string>",
  "status": "RUNNING",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "lastIncrementalCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "lastFullRefreshCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "cacheActionLogs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "action": "<string>",
      "message": "<string>",
      "cacheType": "<string>",
      "isScheduled": true
    }
  ],
  "projectId": "<string>"
}

{
  "id": "<string>",
  "status": "RUNNING",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "lastIncrementalCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "lastFullRefreshCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "cacheActionLogs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "action": "<string>",
      "message": "<string>",
      "cacheType": "<string>",
      "isScheduled": true
    }
  ],
  "projectId": "<string>"
}

Data -- Cache

Get Cache Status

Returns the current status of a specific cache, including execution details for both the last incremental sync and the last full refresh.

The top-level status field is computed from the most recent execution across both sync types:

NOT_INITIALIZED: No sync has ever been executed for this cache.
RUNNING: At least one sync (incremental or full refresh) is currently in progress.
COMPLETED: The most recent sync completed successfully.
FAILED: The most recent sync failed. Check the error field in the relevant execution info for details.
CANCELLED: The most recent sync was cancelled via a cancel endpoint.

Each execution info object (lastIncrementalCacheExecution, lastFullRefreshCacheExecution) contains:

id: Unique execution identifier.
status: Execution-specific status (RUNNING, COMPLETED, FAILED, CANCELLED).
progress: Real-time progress with record counts (cached, inserted, updated, deleted).
error: Error details if the execution failed.
createdAt, updatedAt, finishedAt: Timestamps tracking execution lifecycle.

Use excludeLogs=true to omit the cacheActionLogs array for a lighter response, especially when polling for status during an active sync.

GET

data

projects

{projectId}

cache

{cacheId}

status

Get Cache Status

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

import requests

url = "https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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}/cache/{cacheId}/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

{
  "id": "<string>",
  "status": "RUNNING",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "lastIncrementalCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "lastFullRefreshCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "cacheActionLogs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "action": "<string>",
      "message": "<string>",
      "cacheType": "<string>",
      "isScheduled": true
    }
  ],
  "projectId": "<string>"
}

{
  "id": "<string>",
  "status": "RUNNING",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "lastIncrementalCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "lastFullRefreshCacheExecution": {
    "id": "<string>",
    "executionMode": "<string>",
    "status": "<string>",
    "error": {},
    "progress": {
      "numberOfCachedRecords": 123,
      "numberOfInsertedRecords": 123,
      "numberOfUpdatedRecords": 123,
      "numberOfDeletedRecords": 123,
      "lastOffset": "<string>",
      "lastCacheTxId": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z"
  },
  "cacheActionLogs": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "action": "<string>",
      "message": "<string>",
      "cacheType": "<string>",
      "isScheduled": true
    }
  ],
  "projectId": "<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

The unique identifier of the project that owns the cache

cacheId

string

required

The unique identifier of the cache to check (UUID format)

Query Parameters

excludeLogs

boolean

When true, omits the cacheActionLogs array from the response for a lighter payload. Defaults to false.

Response

Cache status retrieved successfully.

string

The ID of the cache.

status

enum<string>

The status of the cache. RUNNING, CANCELLED, FAILED, COMPLETED, DELETED, NOT_INITIALIZED

Available options:

RUNNING,

CANCELLED,

FAILED,

COMPLETED,

DELETED,

NOT_INITIALIZED

catalogId

string

The ID of the catalog that the cache belongs to.

schemaName

string

The name of the schema that the cache belongs to.

tableName

string

The name of the table that the cache belongs to.

lastIncrementalCacheExecution

object

Show child attributes

lastFullRefreshCacheExecution

object

Show child attributes

cacheActionLogs

object[]

The list of cache action logs

Show child attributes

projectId

string

The ID of the project that the cache belongs to.

API Documentation

Organization -- Organizations

Organization -- Workspaces

Organization -- Projects

Projects (Deprecated)

Projects -- Api Key

Connections

Data -- Catalogs

Data -- Internal Tables

Data -- Queries

Data -- Query Folders

Data -- Semantic Catalogs

Data -- Cache

Data -- Exports

Data -- Parametric Tables

Embedded Peaka Api

Supported Drivers

Data -- Metadata

AI -- AgentV2

Data -- SQL

Data -- Materialized Queries

Get Cache Status

Authorizations

Path Parameters

Query Parameters

Response