Actions27
- Advanced Actions
- Api Keys Actions
- Clusters Actions
- Dictionaries Actions
- Indices Actions
Indices → Check task status
AI-generatedOverview
This node operation checks the status of a specific task in an Algolia index. It is useful for monitoring the progress or completion of asynchronous tasks such as indexing, updating, or deleting records in Algolia. For example, after submitting a batch update to an index, you can use this operation to verify if the task has been completed successfully by providing the unique task ID.
Use Case Examples
- Check the status of a task with ID 1506303845001 on the 'products' index to ensure the indexing operation has finished.
- Monitor the progress of a data update task on a specific Algolia index by querying its task status.
Properties
| Name | Meaning |
|---|---|
| Index Name | Name of the index on which to perform the operation. This is required to specify the target index for the task status check. |
| Task ID | Unique task identifier. This is required to specify which task's status to check. |
| Request Options | Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior. |
Output
JSON
status- The current status of the task (e.g., 'published', 'notPublished').taskID- The unique identifier of the task being checked.updatedAt- Timestamp indicating when the task status was last updated.
Dependencies
- An API key credential for authenticating requests to the Algolia API.
Troubleshooting
- Ensure the provided Index Name exists and is correctly spelled to avoid 'index not found' errors.
- Verify that the Task ID is a valid numeric identifier corresponding to a submitted task.
- Check network connectivity and proxy settings if the request fails to reach the Algolia API.
- If SSL certificate validation fails and you trust the endpoint, enable the 'Ignore SSL Issues' option to bypass certificate errors.
Links
- Algolia API - Get Task - Official Algolia API documentation for checking the status of a task.