post
https://{yourinstance}.makaira.io/stream/fields
Returns the fields associated with the specified datatype, such as product fields.
Returns the available fields for a given document datatype. Used to determine which fields can be included in a stream configuration.
Requires authentication.
Request
POST /stream/fields
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Content-Type | application/json |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
datatype | string | Yes | The document datatype to retrieve fields for. Common values: product, category, manufacturer. |
Example Request
{
"datatype": "product"
}Response
Returns a JSON array of field descriptor objects.
Response Body
| Field | Type | Description |
|---|---|---|
id | string | Field identifier used in queries and stream configuration. |
title | string | Human-readable field name. |
type | string | Data type of the field (e.g. string, integer, float, boolean). |
Example Response
[
{
"id": "title",
"title": "Product Title",
"type": "string"
},
{
"id": "price",
"title": "Price",
"type": "float"
},
{
"id": "active",
"title": "Active",
"type": "boolean"
}
]