RedCircle API integration

Get 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.

Get collection

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

Get requests csv links

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.

Get requests json links

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.

Get result set csv

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.

Get result set json

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.

Get result set jsonlines

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.

Get target product data

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.

List 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.

List collections

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.

List destinations

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.

List error logs

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.

Add zipcodes

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.

Clear collection requests

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.

Create collection

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.

Create destination

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.

Create requests

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.

Delete collection

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

Delete destination

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

Delete request

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.

Delete requests bulk

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.

Delete zipcodes

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

Resend webhook

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.

Start 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.