Download OpenAPI specification:Download
N/A (this description is removed during bundling)
Returns paginated search results from the specified entities with the given search parameters.
| indices required | string (SearchIndicesParameters) Value: "product-catalog" Determines which entity sets to search |
| q | string (SearchQueryParameters) Determines how to filter search results |
| join | string (SearchJoinParameters) Example: join=versions,versions.documents Determines which sub-entities to include in search results |
| page[size] | integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items. |
| page[number] | integer Example: page[number]=1 Determines which page of the entities to retrieve. |
{- "data": [
- {
- "index": "product-catalog",
- "source": {
- "created_at": "2023-01-19T17:41:55.896Z",
- "updated_at": "2023-01-20T17:41:55.896Z",
- "id": "e35b0beb-c3f7-4f8f-95f7-cd8ff0ee478e",
- "name": "Great Product",
- "description": "Great products are built with great care",
- "document_count": 5,
- "version_count": 5,
- "public_labels": {
- "env": "test"
}, - "latest_version": {
- "name": "v5",
- "id": "455b0beb-c3f7-4f8f-95f7-cd8ff0ee478e"
}
}
}
], - "meta": {
- "page": {
- "number": 1,
- "size": 10,
- "total": 4
}
}
}