GET
/
data
/
projects
/
{projectId}
/
cache
/
{cacheId}
/
status
curl --request GET \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/{cacheId}/status \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "RUNNING",
  "appId": "<string>",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "lastIncrementalCacheExecution": {
    "id": "<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>",
    "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string
required

Project ID

​
cacheId
string
required

Cache ID

Query Parameters

​
excludeLogs
boolean

Exclude Logs

Response

200 - */*
OK
​
id
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
​
appId
string

The ID of the app that the cache belongs to.

​
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
​
lastFullRefreshCacheExecution
object
​
cacheActionLogs
object[]

The list of cache action logs