Skip to main content
GET
/
2
/
tasks
/
{taskID}
curl
curl --request GET \
  --url https://data.us.algolia.com/2/tasks/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'
{
  "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
  "cron": "* * 1 * *",
  "lastRun": "<string>",
  "nextRun": "<string>",
  "owner": "<string>",
  "input": {
    "mapping": {
      "format": "mappingkit/v1",
      "actions": [
        {
          "id": "<string>",
          "enabled": true,
          "trigger": "<string>",
          "fieldDirectives": [
            {
              "fieldKey": "<string>",
              "value": {}
            }
          ]
        }
      ]
    }
  },
  "enabled": true,
  "failureThreshold": 50,
  "action": "replace",
  "subscriptionAction": "replace",
  "cursor": "<string>",
  "notifications": {
    "email": {
      "enabled": true
    }
  },
  "policies": {
    "criticalThreshold": 5
  },
  "createdAt": "<string>",
  "updatedAt": "<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

​
taskID
string
required

Unique identifier of a task.

Example:

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

Response

OK

​
taskID
string
required

Universally unique identifier (UUID) of a task.

Example:

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

​
sourceID
string
required

Universally uniqud identifier (UUID) of a source.

Example:

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

​
destinationID
string
required

Universally unique identifier (UUID) of a destination resource.

Example:

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

​
enabled
boolean
default:true
required

Whether the task is enabled.

​
createdAt
string
required

Date of creation in RFC 3339 format.

​
updatedAt
string
required

Date of last update in RFC 3339 format.

​
cron
string

Cron expression for the task's schedule.

Example:

"* * 1 * *"

​
lastRun
string

The last time the scheduled task ran in RFC 3339 format.

​
nextRun
string

The next scheduled run of the task in RFC 3339 format.

​
owner
string | null

Owner of the resource.

​
input
object

Configuration of the task, depending on its type. Input for a streaming task whose source is of type ga4BigqueryExport and for which extracted data is continuously streamed.

  • Option 1
  • Option 2
  • Option 3
​
failureThreshold
integer

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

Required range: 0 <= x <= 100
​
action
enum<string>

Action to perform on the Algolia index.

Available options:
replace,
save,
partial,
partialNoCreate,
append
​
subscriptionAction
enum<string>

Action to perform on the Algolia index.

Available options:
replace,
save,
partial,
partialNoCreate,
append
​
cursor
string

Date of the last cursor in RFC 3339 format.

​
notifications
object

Notifications settings for a task.

​
policies
object

Set of rules for a task.

⌘I