Returns the list of available fields for a given document data type. Used to build stream query conditions and feed configurations.
Requires one of the following permissions: stream:fields:read, streams.read, search.read, smartbundle.read, or recommendations.read.
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 data type to retrieve fields for (e.g. "product", "category"). |
forFeed | boolean | No | When true, script-type fields are excluded and feed-specific taxonomy fields (googleCategory, iCountLine) are prepended. |
Example Request
{
"datatype": "product",
"forFeed": false
}Response
Returns a JSON array of field descriptor objects.
Response Body
| Field | Type | Description |
|---|---|---|
id | string | The field identifier. |
title | string | Human-readable field label. |
type | string | Field data type (e.g. "keyword", "float", "boolean", "script"). |
Example Response
[
{
"id": "price",
"title": "Price",
"type": "float"
},
{
"id": "manufacturer",
"title": "Manufacturer",
"type": "keyword"
}
]