API Documentation
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.
Create Batch Cache
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/batch \
--header 'Content-Type: application/json' \
--data '[
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "customers"
},
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "charges",
"incrementalCacheSchedule": {
"type": "BASIC",
"expression": "PT6H"
}
},
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "invoices",
"fullRefreshCacheSchedule": {
"type": "BASIC",
"expression": "PT24H"
},
"incrementalCacheSchedule": {
"type": "BASIC",
"expression": "PT6H"
}
}
]'[
{
"success": true,
"error": "<string>",
"cache": {
"id": "<string>",
"appId": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
}
]Path Parameters
Body
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a materialized query.
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
This class represents a schedule for a materialized query.
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
Response
The ID of the cache.
The ID of the application for the cache request.
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a materialized query.
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
This class represents a schedule for a materialized query.
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/batch \
--header 'Content-Type: application/json' \
--data '[
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "customers"
},
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "charges",
"incrementalCacheSchedule": {
"type": "BASIC",
"expression": "PT6H"
}
},
{
"catalogId": "627249916703408649",
"schemaName": "payment",
"tableName": "invoices",
"fullRefreshCacheSchedule": {
"type": "BASIC",
"expression": "PT24H"
},
"incrementalCacheSchedule": {
"type": "BASIC",
"expression": "PT6H"
}
}
]'[
{
"success": true,
"error": "<string>",
"cache": {
"id": "<string>",
"appId": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
}
]