List task runs

Retrieve a list of task runs.

GET /1/runs

curl

cURL

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'

200

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

Required ACL: addObject, deleteIndex, editSettings

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

itemsPerPage · integer · default: 10

Number of items per page.

Required range: 1 <= x <= 100

page · integer

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

Required range: x >= 1

status · enum<string>[]

Run status for filtering the list of task runs.

Task run status.

Available options: created, started, finished, skipped

type · enum<string>[]

Run type for filtering the list of task runs.

Task run type.

Available options: reindex, update, discover, validate, push

taskID · string

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

Example:

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

sort · enum<string> · default: createdAt

Property by which to sort the list of task runs.

Available options: status, updatedAt, createdAt

order · enum<string> · default: desc

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

Available options: asc, desc

startDate · string

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

endDate · string

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

Response

200

application/json

OK

runs · object[] · required

Show child attributes

runs. runID · string · required

Universally unique identifier (UUID) of a task run.

Example:

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

runs. appID · string · required

runs. taskID · string · required

Universally unique identifier (UUID) of a task.

Example:

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

runs. status · enum<string> · required

Task run status.

Available options: created, started, finished, skipped

runs. type · enum<string> · required

Task run type.

Available options: reindex, update, discover, validate, push

runs. createdAt · string · required

Date of creation in RFC 3339 format.

runs. progress · runProgress · object

Show child attributes

runs.progress. expectedNbOfEvents · integer · required

runs.progress. receivedNbOfEvents · integer · required

runs. outcome · enum<string>

Task run outcome.

Available options: success, failure

runs. failureThreshold · integer

Maximum accepted percentage of failures for a task run to finish successfully.

Required range: 0 <= x <= 100

runs. reason · string

More information about the task run's outcome.

runs. reasonCode · enum<string>

A code for the task run's outcome. A readable description of the code is included in the reason response property.

Available options: internal, cancelled, critical, no_events, too_many_errors, lacking_events, ok, blocking, idle

runs. startedAt · string

Date of start in RFC 3339 format.

runs. finishedAt · string

Date of finish in RFC 3339 format.

pagination · object · required

Paginated API response.

Show child attributes

pagination. nbPages · integer · required

Number of pages in the API response.

Required range: x >= 1

pagination. page · integer · required

Page of the API response to retrieve.

Required range: x >= 1

pagination. nbItems · integer · required

Number of items in the API response.

Required range: x >= 0

pagination. itemsPerPage · integer · default: 10 · required

Number of items per page.

Required range: 1 <= x <= 100

window · object · required

Time window by which to filter the observability data.

Show child attributes

window. startDate · string · required

Date in RFC 3339 format representing the oldest data in the time window.

window. endDate · string · required

Date in RFC 3339 format representing the newest data in the time window.