​ Filtering tasks with a single parameter

Querying the get tasks endpoint returns all tasks that have not been deleted. This unfiltered list may be difficult to parse in large projects. This guide shows you how to use query parameters to filter tasks and obtain a more readable list of asynchronous operations.

Filtering batches with the /batches route follows the same rules as filtering tasks. Keep in mind that many /batches parameters such as uids target the tasks included in batches, instead of the batches themselves.

​ Filtering tasks with a single parameter

Use the get tasks endpoint to fetch all canceled tasks:

cURL

JS

Python

PHP

Java

Ruby

Go

C#

Rust

Swift

Dart

curl \
  -X GET 'MEILISEARCH_URL/tasks?statuses=failed' \
  -H 'Authorization: Bearer API_KEY'

client.tasks.getTasks({ statuses: ['failed', 'canceled'] })

client.get_tasks({'statuses': ['failed', 'canceled']})

$client->getTasks((new TasksQuery())->setStatuses(['failed', 'canceled']));

TasksQuery query = new TasksQuery().setStatuses(new String[] {"failed", "canceled"});
client.getTasks(query);

client.get_tasks(statuses: ['failed', 'canceled'])

client.GetTasks(&meilisearch.TasksQuery{
  Statuses: []meilisearch.TaskStatus{
    meilisearch.TaskStatusFailed,
    meilisearch.TaskStatusCanceled,
  },
})

await client.GetTasksAsync(new TasksQuery { Statuses = new List<TaskInfoStatus> { TaskInfoStatus.Failed, TaskInfoStatus.Canceled } });

let mut query = TasksQuery::new(&client);
let tasks = query
  .with_statuses(["failed"])
  .execute()
  .await
  .unwrap();

client.getTasks(params: TasksQuery(statuses: [.failed, .canceled])) { result in
  switch result {
  case .success(let taskResult):
    print(taskResult)
  case .failure(let error):
    print(error)
  }
}

await client.getTasks(
  params: TasksQuery(
    statuses: ['failed', 'canceled'],
  ),
);

Use a comma to separate multiple values and fetch both canceled and failed tasks:

cURL

Rust

curl \
  -X GET 'MEILISEARCH_URL/tasks?statuses=failed,canceled' \
  -H 'Authorization: Bearer API_KEY'

let mut query = TasksQuery::new(&client);
let tasks = query
  .with_statuses(["failed", "canceled"])
  .execute()
  .await
  .unwrap();

You may filter tasks based on uid, status, type, indexUid, canceledBy, or date. Consult the API reference for a full list of task filtering parameters.

​ Available filter parameters

All parameters below accept comma-separated values. Filters of different types are combined with a logical AND.

​ Date filters

Use the following parameters to filter tasks by one of their timestamp fields. All values must be valid RFC 3339 dates.

Date filters are equivalent to < or > operations. There is currently no way to perform ≤ or ≥ comparisons with a date filter.

​ Pagination parameters

Combine the filters above with the following parameters to paginate results.

​ Combining filters

Use the ampersand character (&) to combine filters, equivalent to a logical AND:

cURL

JS

Python

PHP

Java

Ruby

Go

C#

Rust

Swift

Dart

curl \
  -X GET 'MEILISEARCH_URL/tasks?indexUids=movies&types=documentAdditionOrUpdate,documentDeletion&statuses=processing' \
  -H 'Authorization: Bearer API_KEY'

client.tasks.getTasks({
  indexUids: ['movies'],
  types: ['documentAdditionOrUpdate','documentDeletion'],
  statuses: ['processing']
})

client.get_tasks(
  {
      'indexUids': 'movies',
      'types': ['documentAdditionOrUpdate', 'documentDeletion'],
      'statuses': ['processing'],
  }
)

$client->getTasks(
  (new TasksQuery())
    ->setStatuses(['processing'])
    ->setUids(['movies'])
    ->setTypes(['documentAdditionOrUpdate', 'documentDeletion'])
);

TasksQuery query =
        new TasksQuery()
                .setStatuses(new String[] {"processing"})
                .setTypes(new String[] {"documentAdditionOrUpdate", "documentDeletion"})
                .setIndexUids(new String[] {"movies"});

client.getTasks(query);

client.get_tasks(index_uids: ['movies'], types: ['documentAdditionOrUpdate', 'documentDeletion'], statuses: ['processing'])

client.GetTasks(&meilisearch.TasksQuery{
  IndexUIDS: []string{"movie"},
  Types:     []meilisearch.TaskType{
    meilisearch.TaskTypeDocumentAdditionOrUpdate,
    meilisearch.TaskTypeDocumentDeletion,
  },
  Statuses:  []meilisearch.TaskStatus{
    meilisearch.TaskStatusProcessing,
  },
})

var query = new TasksQuery { IndexUids = new List<string> { "movies" }, Types = new List<TaskInfo> { TaskInfo.DocumentAdditionOrUpdate, TaskInfo.DocumentDeletion }, Statuses = new List<TaskInfoStatus> { TaskInfoStatus.Processing } };

await client.GetTasksAsync(query);

let mut query = TasksQuery::new(&client);
let tasks = query
  .with_index_uids(["movies"])
  .with_types(["documentAdditionOrUpdate","documentDeletion"])
  .with_statuses(["processing"])
  .execute()
  .await
  .unwrap();

client.getTasks(params: TasksQuery(indexUids: "movies", types: ["documentAdditionOrUpdate", "documentDeletion"], statuses: ["processing"])) { result in
  switch result {
  case .success(let taskResult):
    print(taskResult)
  case .failure(let error):
    print(error)
  }
}

await client.getTasks(
  params: TasksQuery(
    indexUids: ['movies'],
    types: ['documentAdditionOrUpdate', 'documentDeletion'],
    statuses: ['processing'],
  ),
);

This code sample returns all tasks in the movies index that have the type documentAdditionOrUpdate or documentDeletion and have the status of processing.

OR operations between different filters are not supported. For example, you cannot view tasks which have a type of documentAddition or a status of failed.

​ Next steps

Monitor tasks

Check the status of asynchronous operations in real time.

Manage the task database

Navigate long task lists with pagination and query parameters.

Asynchronous operations

Understand how Meilisearch processes tasks in the background.