Skip to main content
GET
/
1
/
runs
/
{runID}
curl
curl --request GET \
  --url https://data.us.algolia.com/1/runs/6c02aeb1-775e-418e-870b-1faccd4b2c0f \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "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>"
}
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.

Path Parameters

ā€‹
runID
string
required

Unique identifier of a task run. Universally unique identifier (UUID) of a task run.

Example:

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

Response

OK

ā€‹
appID
string
required
ā€‹
createdAt
string
required

Date and time when the resource was created, in RFC 3339 format.

ā€‹
runID
string
required

Universally unique identifier (UUID) of a task run.

Example:

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

ā€‹
status
enum<string>
required

Task run status.

Available options:
created,
started,
finished,
skipped
ā€‹
taskID
string
required

Universally unique identifier (UUID) of a task.

Example:

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

ā€‹
type
enum<string>
required

Task run type.

Available options:
reindex,
update,
discover,
validate,
push
ā€‹
failureThreshold
integer

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

Required range: 0 <= x <= 100
ā€‹
finishedAt
string

Date and time when the task finished, in RFC 3339 format.

ā€‹
outcome
enum<string>

Task run outcome.

Available options:
success,
failure
ā€‹
progress
runProgress Ā· object
ā€‹
reason
string

More information about the task run's outcome.

ā€‹
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
ā€‹
startedAt
string

Date and time when the task started, in RFC 3339 format.

Last modified on March 23, 2026