# CatchAll - Get Job Status (`newscatcher/catchall-get-job-status`) Actor Check the current processing status and step progress of a CatchAll job. - **URL**: https://apify.com/newscatcher/catchall-get-job-status.md - **Developed by:** [Newscatcher-CatchAll](https://apify.com/newscatcher) (community) - **Categories:** AI, Automation, News - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $0.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## CatchAll Get Job Status — check job progress CatchAll Get Job Status checks the processing status of a CatchAll job. It returns the current step, progress counts, and completion state. Use it to poll a job after submitting it with [CatchAll Create Job](https://apify.com/newscatcher/catchall-create-job). This Actor maps to the [`GET /catchAll/status/{job_id}`](https://www.newscatcherapi.com/docs/web-search-api/api-reference/jobs/get-job-status) endpoint. ### When to use this Actor - **Poll job progress.** Check whether a job is still processing or has completed. - **Track step-by-step progress.** See which processing stage the job is in: analyzing, fetching, clustering, validating, or extracting. - **Build conditional workflows.** Trigger different actions based on job status using Apify integrations. ### Input | Field | Type | Required | Description | |-------|------|----------|-------------| | `apiKey` | String | Yes | Your CatchAll API key | | `jobId` | String | Yes | Job ID returned by CatchAll Create Job or the main CatchAll Actor | #### Input example ```json { "apiKey": "YOUR_CATCHALL_API_KEY", "jobId": "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c" } ```` ### Output The Actor returns the job status, processing steps, and record counts in the default Dataset. #### Output example ```json { "job_id": "5f0c9087-85cb-4917-b3c7-e5a5eff73a0c", "status": "completed", "limit": 10, "candidate_records": 15, "valid_records": 8, "progress_validated": 15, "steps": [ { "name": "analyzing", "status": "completed", "completed": true }, { "name": "fetching", "status": "completed", "completed": true }, { "name": "clustering", "status": "completed", "completed": true }, { "name": "validating", "status": "completed", "completed": true }, { "name": "extracting", "status": "completed", "completed": true } ] } ``` **Key fields:** - `candidate_records` — total event clusters identified - `valid_records` — records that passed validation - `progress_validated` — how many candidates have been checked so far When `status` is `completed`, use [CatchAll Pull Results](https://apify.com/newscatcher/catchall-pull-results) to retrieve the extracted records. ### Tips - **Poll every 30–60 seconds.** Jobs typically take 10–15 minutes to complete. - **Compare `candidate_records` and `progress_validated`** to estimate remaining processing time. - **Check `valid_records` vs. `limit`** to decide if you need to expand the job with [CatchAll Continue](https://apify.com/newscatcher/catchall-continue). ### Other CatchAll Actors | Actor | Description | |-------|-------------| | [CatchAll](https://apify.com/newscatcher/catchall) | End-to-end job: submit, poll, and retrieve results | | [CatchAll Create Job](https://apify.com/newscatcher/catchall-create-job) | Submit a job without polling | | [CatchAll Pull Results](https://apify.com/newscatcher/catchall-pull-results) | Retrieve records from a completed job | | [CatchAll Early Results](https://apify.com/newscatcher/catchall-early-results) | Get partial results before completion | For the full list, visit the [Newscatcher](https://apify.com/newscatcher) organization page. ### Resources - [CatchAll documentation](https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction) - [Jobs guide](https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/jobs) # Actor input Schema ## `apiKey` (type: `string`): Your CatchAll API key. ## `jobId` (type: `string`): Job ID to check status. ## Actor input object example ```json {} ``` # Actor output Schema ## `overview` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("newscatcher/catchall-get-job-status").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("newscatcher/catchall-get-job-status").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call newscatcher/catchall-get-job-status --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=newscatcher/catchall-get-job-status", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "CatchAll - Get Job Status", "description": "Check the current processing status and step progress of a CatchAll job.", "version": "0.0", "x-build-id": "ZTwB1WswaH5EthWM1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/newscatcher~catchall-get-job-status/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-newscatcher-catchall-get-job-status", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/newscatcher~catchall-get-job-status/runs": { "post": { "operationId": "runs-sync-newscatcher-catchall-get-job-status", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/newscatcher~catchall-get-job-status/run-sync": { "post": { "operationId": "run-sync-newscatcher-catchall-get-job-status", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "apiKey", "jobId" ], "properties": { "apiKey": { "title": "CatchAll API Key", "type": "string", "description": "Your CatchAll API key." }, "jobId": { "title": "Job ID", "type": "string", "description": "Job ID to check status." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```