Skip to main content
GET
/
1
/
runs
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'
{
  "runs": [
    {
      "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "appID": "<string>",
      "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "status": "created",
      "progress": {
        "expectedNbOfEvents": 123,
        "receivedNbOfEvents": 123
      },
      "outcome": "success",
      "failureThreshold": 50,
      "reason": "<string>",
      "reasonCode": "internal",
      "type": "reindex",
      "createdAt": "<string>",
      "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.

Required range: x >= 1
​
status
enum<string>[]

Run status for filtering the list of task runs.

​
type
enum<string>[]

Run type for filtering the list of task runs.

​
taskID
string

Task ID for filtering the list of task runs.

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.

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

OK

​
runs
object[]
required
​
pagination
object
required

Paginated API response.

​
window
object
required

Time window by which to filter the observability data.

⌘I