API Documentation
Organization -> Organizations
Organization -> Workspaces
Organization -> Projects
Projects (Deprecated)
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Data -> Cache
Get Cache Status
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Exclude Logs
Response
200 - */*
OK
The response is of type object
.
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
}
]
}