Get documents by id and/or datatype

post

https://{yourinstance}.makaira.io/documents/public

Get documents directly from Elasticsearch, by id and/or document type.

Body Params

datatype

string

required

Datatype of the documents to retrieve.

Special cases:

makaira-product will retrieve documents with datatype variant (datatype in the response will be makaira-product)
makaira-productgroup will retrieve documents with datatype product (datatype in the response will be makaira-productgroup)
variant will retrieve documents with datatype variant but the datatype in the response will be makaira-product
product will retrieve documents with datatype product but the datatype in the response will be makaira-productgroup

ids

array of strings

The ids of the documents to retrieve.

If this array is undefined or empty then you get all documents of the given datatype. Be careful, this can produce very large responses.

ids

includeContent

boolean

If this is set to true, then the response will contain the content of the documents.

fields

array of strings

Filter for the document fields to retrieve.

If not defined or empty then you will get all public fields that are whitelisted on the details page.

You can not use this to get fields that are not whitelisted.

fields

aggregations

object

List of selected values to filter for.

sorting

object

constraints

object

required

Use this to specify the language and filter the attributes.

Headers

X-Makaira-Instance

string

required

Makaira Instance ID

Responses

200

Array with documents.

500Object with error description.