Icypeas Tools

Icypeas Check Progress

Check the processing progress of a search by its ID. Use this tool after initiating a single or bulk search to monitor its status. For mode='single': Checks progress of individual search items via /bulk-single-searchs/read endpoint. For mode='bulk': Checks progress of bulk searc…

Write ActionRisk level 2 of 5API key connectionFree Action

Use Icypeas Check Progress

Owner App

Icypeas ToolsApp

Required inputs

idRequiredstring

The ID to check: for mode='single', the search item ID (_id); for mode='bulk', the bulk file ID.

modeRequiredstring

Mode of progress check: 'single' for individual search items, 'bulk' for bulk file progress.

nextboolean

Pagination direction: true to fetch the next page, false to fetch the previous page.

typestring

(mode='single' only) Filter results by task type.

limitinteger

Maximum number of records to fetch per page. For single mode: max 100, default 10. For bulk mode: max 50, default 10.

sortsarray

Pagination cursor from a previous response. Required when navigating to next/previous pages.

statusstring

(mode='bulk' only) Filter bulk files by processing status.

Observable output

dataRequired
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulRequiredboolean
Whether or not the action execution was successful or not

Setup and approval

API key connection. Risk level 2 of 5.

Pricing and limits

Free Action

Unified payment: Not currently supported

Skills that use this Action

No published Skills explicitly reference this Action yet.

Official source

Provider source