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

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/{cacheId}/status
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The unique identifier of the project that owns the cache

cacheIdstring required

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

Query parameters

excludeLogsboolean

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

Response

Cache status retrieved successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.