Skip to main content
GET
/
1
/
runs
/
{runID}
/
events
curl
curl --request GET \
  --url 'https://data.us.algolia.com/1/runs/6c02aeb1-775e-418e-870b-1faccd4b2c0f/events?itemsPerPage=10&page=1&status=created&type=fetch&sort=status&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'
{
  "events": [
    {
      "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "status": "created",
      "type": "fetch",
      "batchSize": 10,
      "data": {},
      "publishedAt": "<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.

Path Parameters

​
runID
string
required

Unique identifier of a task run.

Example:

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

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> | null)[]

Event status for filtering the list of task runs.

​
type
enum<string>[]

Event type for filtering the list of task runs.

​
sort
enum<string>

Property by which to sort the list of task run events.

Available options:
status,
type,
publishedAt
​
order
enum<string>
default:desc

Sort order of the response, ascending or descending.

Available options:
asc,
desc
​
startDate
string

Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.

​
endDate
string

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

Response

OK

​
events
object[]
required
​
pagination
object
required

Paginated API response.

​
window
object
required

Time window by which to filter the observability data.

⌘I