curl --request POST \
--url https://data.us.algolia.com/2/tasks/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
--data '
{
"taskIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
]
}
'// Initialize the client
var client = new IngestionClient(
new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);
// Call the API
var response = await client.SearchTasksAsync(
new TaskSearch
{
TaskIDs = new List<string>
{
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
},
}
);
// print the response
Console.WriteLine(response);// Initialize the client
final client = IngestionClient(
appId: 'ALGOLIA_APPLICATION_ID',
apiKey: 'ALGOLIA_API_KEY',
region: 'ALGOLIA_APPLICATION_REGION');
// Call the API
final response = await client.searchTasks(
taskSearch: TaskSearch(
taskIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
),
);
// print the response
print(response);// Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION
client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.SearchTasks(client.NewApiSearchTasksRequest(
ingestion.NewEmptyTaskSearch().SetTaskIDs(
[]string{"6c02aeb1-775e-418e-870b-1faccd4b2c0f", "947ac9c4-7e58-4c87-b1e7-14a68e99699a", "76ab4c2a-ce17-496f-b7a6-506dc59ee498"})))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
// Call the API
List response = client.searchTasks(
new TaskSearch().setTaskIDs(
Arrays.asList(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
);
// print the response
System.out.println(response);// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });
// Call the API
const response = await client.searchTasks({
taskIDs: [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
});
// print the response
console.log(response);// Initialize the client
val client =
IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION",
)
// Call the API
var response =
client.searchTasks(
taskSearch =
TaskSearch(
taskIDs =
listOf(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
)
)
)
// print the response
println(response)// Initialize the client
$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
// Call the API
$response = $client->searchTasks(
['taskIDs' => [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
],
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods.
client = IngestionClientSync(
"ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.search_tasks(
task_search={
"taskIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
},
)
# print the response
print(response)# Initialize the client
client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
# Call the API
response = client.search_tasks(
Algolia::Ingestion::TaskSearch.new(
task_ids: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
]
)
)
# print the response
puts(response)// Initialize the client
val client = IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION"
)
// Call the API
val response = Await.result(
client.searchTasks(
taskSearch = TaskSearch(
taskIDs = Seq(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
// Call the API
let response = try await client.searchTasks(taskSearch: TaskSearch(taskIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
]))
// print the response
print(response)[
{
"createdAt": "<string>",
"destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"enabled": true,
"sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"updatedAt": "<string>",
"cron": "* * 1 * *",
"cursor": "<string>",
"failureThreshold": 50,
"input": {
"mapping": {
"actions": [
{
"enabled": true,
"fieldDirectives": [
{
"fieldKey": "<string>",
"value": {}
}
],
"trigger": "<string>",
"id": "<string>"
}
],
"format": "mappingkit/v1"
}
},
"lastRun": "<string>",
"nextRun": "<string>",
"notifications": {
"email": {
"enabled": true
}
},
"owner": "<string>",
"policies": {
"criticalThreshold": 5
}
}
]{
"message": "Invalid Application-Id or API-Key"
}Search for tasks
Searches for tasks.
curl --request POST \
--url https://data.us.algolia.com/2/tasks/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-algolia-api-key: ALGOLIA_API_KEY' \
--header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
--data '
{
"taskIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
]
}
'// Initialize the client
var client = new IngestionClient(
new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
);
// Call the API
var response = await client.SearchTasksAsync(
new TaskSearch
{
TaskIDs = new List<string>
{
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
},
}
);
// print the response
Console.WriteLine(response);// Initialize the client
final client = IngestionClient(
appId: 'ALGOLIA_APPLICATION_ID',
apiKey: 'ALGOLIA_API_KEY',
region: 'ALGOLIA_APPLICATION_REGION');
// Call the API
final response = await client.searchTasks(
taskSearch: TaskSearch(
taskIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
),
);
// print the response
print(response);// Initialize the client with your application region, eg. ingestion.ALGOLIA_APPLICATION_REGION
client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", ingestion.US)
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.SearchTasks(client.NewApiSearchTasksRequest(
ingestion.NewEmptyTaskSearch().SetTaskIDs(
[]string{"6c02aeb1-775e-418e-870b-1faccd4b2c0f", "947ac9c4-7e58-4c87-b1e7-14a68e99699a", "76ab4c2a-ce17-496f-b7a6-506dc59ee498"})))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)// Initialize the client
IngestionClient client = new IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
// Call the API
List response = client.searchTasks(
new TaskSearch().setTaskIDs(
Arrays.asList(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
);
// print the response
System.out.println(response);// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initIngestion({ region: 'us' });
// Call the API
const response = await client.searchTasks({
taskIDs: [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
});
// print the response
console.log(response);// Initialize the client
val client =
IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION",
)
// Call the API
var response =
client.searchTasks(
taskSearch =
TaskSearch(
taskIDs =
listOf(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
)
)
)
// print the response
println(response)// Initialize the client
$client = IngestionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
// Call the API
$response = $client->searchTasks(
['taskIDs' => [
'6c02aeb1-775e-418e-870b-1faccd4b2c0f',
'947ac9c4-7e58-4c87-b1e7-14a68e99699a',
'76ab4c2a-ce17-496f-b7a6-506dc59ee498',
],
],
);
// print the response
var_dump($response);# Initialize the client
# In an asynchronous context, you can use IngestionClient instead, which exposes the exact same methods.
client = IngestionClientSync(
"ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.search_tasks(
task_search={
"taskIDs": [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
],
},
)
# print the response
print(response)# Initialize the client
client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
# Call the API
response = client.search_tasks(
Algolia::Ingestion::TaskSearch.new(
task_ids: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
]
)
)
# print the response
puts(response)// Initialize the client
val client = IngestionClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION"
)
// Call the API
val response = Await.result(
client.searchTasks(
taskSearch = TaskSearch(
taskIDs = Seq(
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498"
)
)
),
Duration(100, "sec")
)
// print the response
println(response)// Initialize the client
let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
// Call the API
let response = try await client.searchTasks(taskSearch: TaskSearch(taskIDs: [
"6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"947ac9c4-7e58-4c87-b1e7-14a68e99699a",
"76ab4c2a-ce17-496f-b7a6-506dc59ee498",
]))
// print the response
print(response)[
{
"createdAt": "<string>",
"destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"enabled": true,
"sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
"updatedAt": "<string>",
"cron": "* * 1 * *",
"cursor": "<string>",
"failureThreshold": 50,
"input": {
"mapping": {
"actions": [
{
"enabled": true,
"fieldDirectives": [
{
"fieldKey": "<string>",
"value": {}
}
],
"trigger": "<string>",
"id": "<string>"
}
],
"format": "mappingkit/v1"
}
},
"lastRun": "<string>",
"nextRun": "<string>",
"notifications": {
"email": {
"enabled": true
}
},
"owner": "<string>",
"policies": {
"criticalThreshold": 5
}
}
]{
"message": "Invalid Application-Id or API-Key"
}addObject, deleteIndex, editSettingsAuthorizations
Your Algolia application ID.
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.
Body
Universally unique identifier (UUID) of a task.
Response
OK
Date and time when the resource was created, in RFC 3339 format.
Universally unique identifier (UUID) of a destination resource.
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
Whether the task is enabled.
Universally uniqud identifier (UUID) of a source.
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
Universally unique identifier (UUID) of a task.
"6c02aeb1-775e-418e-870b-1faccd4b2c0f"
Date and time when the resource was last updated, in RFC 3339 format.
Action to perform on the Algolia index.
replace, save, partial, partialNoCreate, append Cron expression for the task's schedule.
"* * 1 * *"
Date and time when the last cursor was created, in RFC 3339 format.
Maximum accepted percentage of failures for a task run to finish successfully.
0 <= x <= 100Configuration of the task, depending on its type.
- Streaming input
- Docker streams
- Shopify input
Show child attributes
Show child attributes
The last time the scheduled task ran in RFC 3339 format.
The next scheduled run of the task in RFC 3339 format.
Notifications settings for a task.
Show child attributes
Show child attributes
Owner of the resource.
Set of rules for a task.
Show child attributes
Show child attributes
Action to perform on the Algolia index.
replace, save, partial, partialNoCreate, append Was this page helpful?