List task runs - Algolia

curl --request GET \ --url 'https://data.us.algolia.com/1/runs?itemsPerPage=10&page=1&status=created&type=reindex&taskID=6c02aeb1-775e-418e-870b-1faccd4b2c0f&sort=createdAt&order=desc&startDate=lorem&endDate=lorem' \ --header 'accept: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'

{ "pagination": { "itemsPerPage": 10, "nbItems": 1, "nbPages": 2, "page": 2 }, "runs": [ { "appID": "<string>", "createdAt": "<string>", "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", "failureThreshold": 50, "finishedAt": "<string>", "progress": { "expectedNbOfEvents": 123, "receivedNbOfEvents": 123 }, "reason": "<string>", "startedAt": "<string>" } ], "window": { "endDate": "<string>", "startDate": "<string>" } }

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Query Parameters

endDate

string

Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.

itemsPerPage

integer

default:10

Number of items per page.

Required range: 1 <= x <= 100

order

enum<string>

default:desc

Sort order of the response, ascending or descending. Ascending or descending sort order.

Available options:

asc,

desc

page

integer

Page number of the paginated API response. Page of the API response to retrieve.

Required range: x >= 1

sort

enum<string>

default:createdAt

Property by which to sort the list of task runs.

Available options:

status,

updatedAt,

createdAt

startDate

string

Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.

status

enum<string>[]

Run status for filtering the list of task runs.

Task run status.

Available options:

created,

started,

finished,

skipped

taskID

string

Task ID for filtering the list of task runs. Universally unique identifier (UUID) of a task.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

type

enum<string>[]

Run type for filtering the list of task runs.

Task run type.

Available options:

reindex,

update,

discover,

validate,

push

Response

pagination

object

required

Paginated API response.

Show child attributes

runs

object[]

required

Show child attributes

window

object

required

Time window by which to filter the observability data.

Show child attributes