POST /1/dictionaries/{dictionaryName}/search
Searches for standard and custom dictionary entries.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dictionaryName |
String | Yes |
Dictionary type in which to search. Valid values:
|
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page of search results to retrieve. Default value: 0 |
query |
String | Yes |
Search query. |
hitsPerPage |
Integer | No |
Number of hits per page. Default value: 20 |
language |
String | No |
ISO code for a supported language. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.