GET /1/runs
Retrieve a list of task runs.
Servers
- https://data.{region}.algolia.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page number of the paginated API response. |
order |
String | No |
Sort order of the response, ascending or descending. Possible values:
Default value: "desc" |
endDate |
String | No |
Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used. |
sort |
String | No |
Property by which to sort the list of task runs. Possible values:
Default value: "createdAt" |
type[] |
Array | No |
Run type for filtering the list of task runs. |
status[] |
Array | No |
Run status for filtering the list of task runs. |
itemsPerPage |
Integer | No |
Number of items per page. Default value: 10 |
taskID |
String | No |
Task ID for filtering the list of task runs. |
startDate |
String | No |
Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used. |
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.