List task run events

Retrieves a list of events for a task run, identified by its ID.

GET /1/runs/{runID}/events

curl

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'

200

{
  "events": [
    {
      "eventID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "runID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
      "status": "created",
      "type": "fetch",
      "batchSize": 10,
      "publishedAt": "<string>",
      "data": {}
    }
  ],
  "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. Universally unique identifier (UUID) 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. Page of the API response to retrieve.

Required range: x >= 1

status · (enum<string> | null)[]

Event status for filtering the list of task runs.

Available options: created, started, retried, failed, succeeded, critical

type · enum<string>[]

Event type for filtering the list of task runs.

Available options: fetch, record, log, transform

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. Ascending or descending sort order.

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

200

application/json

OK

events · object[] · required

Show child attributes

events. eventID · string · required

Universally unique identifier (UUID) of an event.

Example:

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

events. runID · string · required

Universally unique identifier (UUID) of a task run.

Example:

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

events. status · enum<string> | null · required

Available options: created, started, retried, failed, succeeded, critical

events. type · enum<string> · required

Available options: fetch, record, log, transform

events. batchSize · integer · required

The extracted record batch size.

Required range: x >= 0Must be a multiple of 1

Example:

10

events. publishedAt · string · required

Date of publish RFC 3339 format.

events. data · object

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.