RedCircle API

Tool to add zipcodes to your RedCircle API account for geolocation targeting. Use when you need to localize product searches by specific postal codes. New zipcodes take approximately 2 minutes to become available after being added.

Tool to remove all requests from a specified collection. Collections can only be cleared when not actively running. Use when you need to empty a collection of all its requests.

Tool to create a new collection for running up to 15,000 requests on a schedule. Use when you need to organize and schedule batch requests with various scheduling patterns, priority levels, and notification methods.

Tool to create a new destination for uploading Collection Result Sets to cloud storage. Use when you need to configure a storage destination for result sets with providers like S3, GCS, Azure, OSS, or S3-compatible storage.

Tool to add up to 1,000 requests to an existing collection. Use when you need to populate a collection with product requests. Collections have a maximum of 15,000 requests (100 if include_html=true). Sequential calls required; parallel requests trigger HTTP 429 errors.

Tool to remove a collection from the system by ID. Use when you need to delete a collection that is not currently running.

Tool to remove a destination from your RedCircle API account. Use when you need to permanently delete a specific destination by its ID.

Tool to remove an individual request from a collection. Use when you need to delete a specific request from a collection by providing both collection_id and request_id. Collections must not be running during deletion.

Tool to delete multiple requests from a collection in bulk. Use when you need to remove multiple requests efficiently. Note: Requests can only be deleted when the collection is not running.

Tool to remove zipcodes from your RedCircle API account. Use when you need to delete specific zipcode/domain pairs from your account.

Tool to retrieve account information, usage metrics, and platform status. Use when you need to check account credits, limits, plan details, or platform component status.

Tool to retrieve complete information about a specific collection. Use when you need detailed collection metadata including status, schedule, and configuration.

Tool to retrieve CSV download links for all requests in a collection. Use when you need to export request data in CSV format. Each CSV file contains up to 1000 requests.

Tool to retrieve download links for all requests in a collection in JSON format. Use when you need to access request data from a specific collection. Returns paginated URLs for downloading request information.

Tool to retrieve a result set in CSV format with optional field filtering. Use when you need to export processed results from a collection as CSV files. Supports field selection using dot notation for nested fields. Results maintain 14-day retention.

Tool to retrieve a result set in JSON format with download links. Use when you need to access processed results from a specific collection and result set. Returns detailed result information including download URLs for data files.

Tool to retrieve a result set in JSON Lines format with download links. Use when you need to access processed results as newline-delimited JSON files. JSON Lines format provides one valid JSON object per line, ideal for streaming and processing large datasets.

Tool to retrieve Target data in real-time including search results, product information, reviews, or category listings. Use when you need to access Target.com product data such as searching for products, getting specific product details, retrieving reviews, or listing categories.

Tool to retrieve all top-level (root) categories or filter results using optional parameters. Use when you need to browse the category hierarchy, search for specific categories, or retrieve category details. Parameters id, parent_id, and search_term are mutually exclusive.

Tool to retrieve all collections configured on your RedCircle API account with filtering and pagination. Use when you need to browse collections, filter by status or search term, or manage collection metadata.

Tool to retrieve all destinations configured on your RedCircle API account with pagination and filtering. Use when you need to browse or manage destination configurations. Returns 10 destinations per page.

Tool to list all error logs on your RedCircle API account. Use when you need to retrieve failed API request logs with error details. Results are paginated with 10 error logs per page. Supports filtering by search term and sorting by date or count.

Tool to retrieve requests for a collection in paginated format. Use when you need to access collection requests with pagination support (max 1000 requests per page).

Tool to list all result sets for a collection. Use when you need to retrieve execution history and results for a specific collection. Note: result sets have 14-day retention.

Tool to retrieve all zipcodes associated with your account with optional filtering. Use when you need to list zipcodes, optionally filtered by search term or domain. Supports pagination with max 10 results per page.

Tool to resend a previously configured webhook POST request for a result set. Use when you need to debug webhook connectivity issues without re-executing the collection.

Tool to initiate execution of a RedCircle API collection. Use when you need to start processing requests for a collection. Requires sufficient request credits and the collection must not be currently running.

Tool to halt all currently active collections on your account. Use when you need to terminate all collection operations across your account. Collections in queued or running states are affected, resetting status to idle. Note: Queued collections receive credit refunds; running collections stop without reimbursement.

Tool to halt an active collection in queued or running state. Use when you need to stop a collection that is currently processing. Collections in queued status receive full credit refunds, while running collections are stopped without refunds.

Tool to update an existing collection's configuration and settings. Use when you need to modify collection settings including name, schedule, priority, and destination assignments. Note: A collection can only be updated when it is not running.

Tool to modify an existing destination configuration on your RedCircle API account. Use when you need to update destination settings such as name, credentials, storage paths, or enable/disable status. When enabling a previously disabled destination or updating credentials, a connectivity test will be performed automatically.

Tool to modify a request within a collection. Use only when the collection is not running. Updates request parameters like type, tcin, or other Target Product Data API fields.