Skip to main content
POST
/
data
/
projects
/
{projectId}
/
search
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "apple"
}
'
{
  "matchedCatalogs": [
    {
      "catalog": "apple_catalog"
    }
  ],
  "matchedSchemas": [
    {
      "catalog": "my_catalog",
      "schema": "apple_schema"
    }
  ],
  "matchedTables": [
    {
      "catalog": "my_catalog",
      "schema": "apple_schema",
      "table": "apple_table"
    },
    {
      "catalog": "my_catalog",
      "schema": "another_schema",
      "table": "another_apple_table"
    }
  ],
  "meta": {
    "page": {
      "limit": 100,
      "offset": 0,
      "nextOffset": null
    },
    "query": {
      "text": "apple"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the project

Body

application/json

Search Anywhere

​
catalog
string

Catalog Query Name. Search only for that catalog.

​
schema
string

Schema Name. Search only for that schema. If catalog is also given, find the tables under catalog.schema.*

​
query
string

Search term. Does a case-insensitive contains search.

​
limit
integer<int32>

Number of results to return. Default is 100.

​
offset
integer<int32>

Number of results to skip. Default is 0.

Response

200 - application/json

Successful Search

​
matchedCatalogs
object[]

Catalogs matched.

​
matchedSchemas
object[]

Schemas matched.

​
matchedTables
object[]

Tables matched.

​
meta
object