/metadata/searchSearch Metadata
Create search. (Data, Queries & Vectors) POST /@:projectSlug/metadata/search.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| surface * | string | A surface label The scope is 1 to 128 characters of letters, digits, Only a collection surface is accepted here. |
| field * | string | The declared text column to search, as Not a protected column. |
| q * | string | The full-text search terms. |
| limit | integer | How many rows to return, as the record read's |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 400 | K9O_INVALID_FIELD_VALUE | The body is malformed: an unknown field, a wrong type, or an unsupported where operator. |
| 400 | K9O_UNKNOWN_SURFACE | A surface is not collection:<name>, storage:<bucket> or telemetry:<eventType>. |
| 400 | K9O_METADATA_FIELD_NOT_INDEXED | A field is not a declared metadata field of the surface (ch04 §1.3.1); declare it with PUT /metadata/index/{collection}. |
| 401 | K9O_INVALID_CREDENTIALS | The caller is not authenticated. |
| 403 | K9O_ACCESS_DENIED | The caller has no read access to the collection (the record read's own gate). |
| 403 | K9O_EXTENSION_PERMISSION_DENIED | An extension token: the Metadata API is not extension-callable yet. |
| data * | object[] | The matching rows. A query over several surfaces lists each surface's rows in the order the surfaces were named. |
| surface * | string | The surface label the row came from, as sent. |
| scope * | string | The surface's scope: the collection name, or the audit event type for telemetry. |
| recordId | string | The record's id. Present on collection rows only. |
| eventId | string | The audit event's id. Present on telemetry rows only. |
| metadata * | object | For a collection surface: the record's declared metadata columns (see PUT /metadata/index/{collection}), keyed by column name, with each value as the record read returns it (string, number, boolean, null, or an array or object for array and jsonb columns). A declared column the record read did not return is absent. For a telemetry surface: the audit event as GET /audit-log returns it. |
| meta * | any | Request metadata (request id, trace id, timing and cost) plus |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.metadata.search({})Showing example in TypeScript
{
"surface": "string",
"field": "string",
"q": "string",
"limit": 0
}{
"data": [
{
"surface": "string",
"scope": "string",
"recordId": "string",
"eventId": "string"
}
]
}