Peaka is a powerful data management backend that enables seamless integration and efficient data operations. Users can create projects to organize their data and establish catalogs for easier access. Users can run queries to retrieve specific information or perform operations. Peaka’s caching capabilities enhance performance by storing frequently accessed data, reducing retrieval times. This ensures efficient data operations, allowing users to focus on insights rather than waiting for processes to complete. Overall, Peaka empowers users to manage their data effectively in backend.

​
Key Features

  • Seamless Integration: Easily connect with various third-party services to enhance your data management capabilities.
  • Efficient Data Operations: Utilize APIs for creating projects, catalogs, and executing queries to streamline your data workflows.
  • Advanced Caching: Optimize performance with a versatile caching API that supports creating, updating, and managing cache states.
  • Query Execution: Execute queries to retrieve specific information or perform operations.

​
Step-by-Step Implementation

​
1. Creating Partner API Key

  • Prior to initiating the creation of a project, it is essential to generate a Partner API key. This key serves as a crucial authentication mechanism for your project creation requests to the Peaka API, ensuring secure and authorized access.
  • Navigate to the Developer section.
  • Click on the Partner API Key button to open a dialog box.
  • Fill in the form by entering your desired API Key Name.
  • Click on the Create button.
  • You can copy the API key from the dialog box.
For detailed guidance, please refer to the documentation on how to create a partner API key. created partner api key dialog

​
2. Creating a Project

  • Now you have your partner API key, and you need to create a project that will act as a centralized repository for effectively storing and caching your data.
  • Create your project by using below API.
For detailed guidance, please refer to the documentation on how to create a project. 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/projects \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "Sample Project Name"
}'

{
    "id": "URNg0GIj",
    "name": "Sample Project Name",
    "description": "Non accusantium ducimus accusantium. Laborum eum accusamus sit sit hic eaque doloremque. Occaecati blanditiis facere consequuntur consectetur culpa reiciendis hic tempore dolorem. Saepe impedit nam necessitatibus maxime numquam voluptatum cum. Adipisci mollitia blanditiis sint inventore ex commodi occaecati ipsam quas.",
    "domain": "sampleprojectname-cdcn",
    "webhookBaseUrl": "https://sampleprojectname-cdcn--test.api.peaka.host",
    "createdAt": "2024-09-10T10:11:02.385253956Z"
}

​
3. Create a API Key

  • Now that you have created your project, you need to create a API key for your project.
  • You will use the API key to authenticate your requests to the Peaka API.
For detailed guidance, please refer to the documentation on how to create a partner API key. 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/projects/{projectId}/apiKeys \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "test"
}'

{
    "name": "test",
    "apiKey": "TtgGcQFq.s3fzROFoop8uHG4pS2LYhoqn1rLb6oW6",
    "apiKeyId": "21fd1a8d-88d5-4295-b792-5b2113138057"
}

​
4. Creating a Catalog

  • You have successfully created your project and obtained your API key.
  • The next step is to create a catalog, which will serve as a structured collection of data sourced from a specific origin.
  • To view all available catalogs, you can utilize the API. See the documentation on how to get a catalog list for further instructions.
For detailed guidance, please refer to the documentation on how to create a catalog . 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "exampleAirtableCatalog",
    "catalogType": "airtable",
    "connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}'

{
    "id": "626654862255325504",
    "name": "exampleairtablecatalog",
    "displayName": "exampleAirtableCatalog",
    "catalogType": "airtable",
    "connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}

​
5. Cache Your Catalog

  • In this step, we will cache your catalog. This allows you to store frequently accessed data in a temporary storage area, which significantly enhances data retrieval speeds.
For detailed guidance, please refer to the documentation on how to cache a catalog. 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache \
    --header 'Content-Type: application/json' \
    --data '{
    "catalogId": "627249916703408649",
    "schemaName": "payment",
    "tableName": "customers"
}'

{
    "id": "<string>",
    "appId": "<string>",
    "catalogId": "<string>",
    "schemaName": "<string>",
    "tableName": "<string>",
    "incrementalCacheSchedule": {
        "expression": "<string>"
    },
    "fullRefreshCacheSchedule": {
        "expression": "<string>"
    }
}

​
6. Write Your Query

  • Now you have created your project, API key, and catalog. Also cached your catalog.
  • You are now ready to create queries that allow you to extract and refine data from your catalog based on your requirements.
For detailed guidance, please refer to the documentation on how to create a query. 
curl --request POST \
    --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries \
    --header 'Content-Type: application/json' \
    --data '{
    "displayName": "sampleQuery",
    "inputQuery": "SELECT * from \"mycatalog\".payment.customers"
}'

{
    "id": "<string>",
    "displayName": "<string>",
    "name": "<string>",
    "inputQuery": "<string>",
    "inputQueryRefId": "<string>",
    "queryType": "<string>",
    "schedule": {
        "expression": "<string>"
    }
}

​
7. Run Your Query

  • Last step is to run your query.
  • After running query is completed, you will get the data in response. You can use this data for further processing or analysis as needed.
For detailed guidance, please refer to the documentation on how to run a query. 
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \
--header 'Content-Type: application/json' \
--data '{
"from": [
    {
    "catalogName": "peaka",
    "schemaName": "query",
    "tableName": "samplequery"
    }
]
}'

{
  "columns": [
    {
      "catalogId": "2",
      "catalogName": "peaka",
      "schemaName": "query",
      "tableName": "samplequery",
      "columnName": "amount"
    }
  ],
  "data": [
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ],
    [
      {
        "name": "amount",
        "displayName": "amount",
        "dataType": "bigint",
        "value": "75",
        "order": 0
      }
    ]
  ]
}

​
8. Success

  • You have successfully created your project, generated your API key, established your catalog, cached the catalog, and executed your query.
  • This data is now ready for advanced processing and insightful analysis.
  • You have effectively integrated Peaka as your robust data management backend.