Data -- Catalogs

Search

Search for catalogs, schemas, and tables across the project. You can filter the search results by specifying a catalog or schema. You can also specify a limit and offset for pagination.

See the request body for more details.

post/data/projects/{projectId}/search

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/search
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the project

Request body

catalogstring

Catalog Query Name. Search only for that catalog.

schemastring

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

querystring

Search term. Does a case-insensitive contains search.

limitinteger

Number of results to return. Default is 100.

offsetinteger

Number of results to skip. Default is 0.

Response

Successful Search

Example response

{
  "meta": {
    "query": {
      "schedule": {
        "type": "cron",
        "cronExpression": "0 0 * * *",
        "timezone": "UTC"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.