Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Tasks → Get All Tasks

AI-generated

Overview

This node operation fetches a list of tasks from the Meilisearch API with various filtering and pagination options. It is useful for retrieving task data such as status, type, and timestamps, allowing users to monitor and manage tasks programmatically. For example, it can be used to get all tasks enqueued after a certain date or to limit the number of returned tasks for performance optimization.

Use Case Examples

  1. Retrieve all tasks with a limit of 50 results.
  2. Fetch tasks filtered by specific UIDs or statuses.
  3. Get tasks enqueued before or after a certain date/time.

Properties

Name Meaning
Limit Maximum number of task results to return.
From Fetch the next set of results starting from the given UID for pagination.
UIDs Comma delimited list of task UIDs to filter the results by.
Index UIDs Comma delimited list of index UIDs to filter the tasks by.
Statuses Comma delimited list of task statuses to filter the results by.
Types Comma delimited list of task types to filter the results by.
Canceled By Comma delimited list of task UIDs that canceled other tasks to filter by.
Before Enqueued At Filter tasks enqueued before this date/time.
After Enqueued At Filter tasks enqueued after this date/time.
Before Started At Filter tasks started before this date/time.
After Started At Filter tasks started after this date/time.
Before Finished At Filter tasks finished before this date/time.
After Finished At Filter tasks finished after this date/time.

Output

JSON

  • json
    • ``
      * uid - Unique identifier of the task.
      * status - Current status of the task (e.g., succeeded, failed, canceled).
      * type - Type of the task.
      * enqueuedAt - Timestamp when the task was enqueued.
      * startedAt - Timestamp when the task started.
      * finishedAt - Timestamp when the task finished.
      * details - Additional details about the task.

Dependencies

  • Meilisearch API key credential

Troubleshooting

  • Ensure the Meilisearch API credentials are correctly configured and have the necessary permissions to access tasks.
  • If the node times out waiting for task completion, increase the timeout or check the task status manually.
  • Verify that date/time filters are provided in a valid format to avoid query errors.

Links

  • Meilisearch Tasks API - Official documentation for the Meilisearch Tasks API, detailing available filters and task properties.

Discussion