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

eventID
string
required

Unique identifier of an event.

Example:

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

Response

OK

An event describe a step of the task execution flow..

eventID
string
required

Universally unique identifier (UUID) of an event.

Example:

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

runID
string
required

Universally unique identifier (UUID) of a task run.

Example:

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

status
enum<string> | null
required
Available options:
created,
started,
retried,
failed,
succeeded,
critical
type
enum<string>
required
Available options:
fetch,
record,
log,
transform
batchSize
integer
required

The extracted record batch size.

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

10

publishedAt
string
required

Date of publish RFC 3339 format.

data
object | null
I