RedCircle API

Pulls real time Target product data, reviews, and pricing into your workflows and manages batch collection requests for large scale catalog monitoring.

Try RedCircle API in Ceven

Ask Ceven anything
Standard

Why use Ceven?

  1. AI native RedCircle API integration

    • Describe the outcome and Ceven picks the right RedCircle API calls, fills the parameters, and checks the result.
    • Structured, agent friendly tool schemas so each call runs reliably instead of by guesswork.
    • Rich coverage for reading, writing, and querying your RedCircle API data, across all 32 of its actions.
  2. Managed auth

    • Built in OAuth with automatic token refresh and rotation.
    • One place to manage, scope, and revoke RedCircle API access.
    • Per user and per environment credentials instead of shared keys.
  3. Agent optimized design

    • Actions are tuned from real success and error rates so reliability climbs over time.
    • Full execution logs so you always know what ran in RedCircle API, when, and on whose behalf.
    • The agent pauses and asks when RedCircle API is unclear instead of plowing ahead.
  4. Enterprise grade security

    • Fine grained access so you control which agents and people can reach RedCircle API.
    • Least privilege by default, read scopes first and only the writes a workflow needs.
    • A full audit trail of every RedCircle API action to support review and sign off.

Supported tools

Every action Ceven's agents can run on RedCircle API, and when to use it.

Get Target Product Data
Pull real time search results, product details, reviews, or category listings from Target.
List Categories
Retrieve all top level root categories or filter for specific category data.
Create Collection
Set up a new collection to run up to 15000 requests on a custom schedule.
Create Requests
Add up to 1000 product requests to an existing collection for batch processing.
Start Collection
Trigger the execution of a RedCircle API collection to begin processing requests.
Stop Collection
Halt an active collection in queued or running state to stop further processing.
Get Result Set JSON
Retrieve processed results from a specific collection and result set in JSON format.
Get Result Set CSV
Export processed collection results as CSV files with optional field filtering.
Add Zipcodes
Add specific postal codes to the account to localize product searches and inventory.
List Zipcodes
Pull all zipcodes associated with the account, optionally filtered by search term.
Create Destination
Configure a cloud storage destination like S3 or GCS for collection result sets.
Get Account Information
Check current account credits, plan limits, and overall platform status.
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.
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 from Collection
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 In 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.
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 JSON Lines
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 proces
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
List Requests by Page
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).
List Result Sets
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.
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.
Stop All Collections
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 collec
Update Collection
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 runni

30 actions · scroll to see them all

Frequently asked questions

The collection system allows you to group up to 15000 requests into a single entity. You first create the collection and then add requests in batches of 1000. Once the requests are populated, you start the collection to process them. This is far more efficient than making thousands of individual API calls. Results are stored in result sets which you can then download as JSON or CSV. Note that result sets have a strict 14 day retention period, so you must export your data to a destination or download it before it is deleted from the system.
Yes. Target often varies pricing and availability by store location. RedCircle API handles this through the zip code management tools. You can add specific zip codes to your account to tell the API which regional data to pull. Once a zip code is added, it typically takes about 2 minutes to become active in the system. When you make a product request, the API uses these configured zip codes to return the most accurate local data, which is critical for businesses running regional price parity audits.
When you stop a collection, the outcome depends on its current state. If the collection is in a queued state, you receive a full refund of the request credits. If the collection is already running, you are only refunded for the requests that have not yet been processed. This allows you to kill a job if you realize the request parameters were incorrect without losing all your credits. You can also use the stop all collections command to terminate every active process on your account simultaneously.
Yes, there are specific limits based on the type of data you request. A standard collection can hold up to 15000 requests. However, if you set the include html parameter to true, the limit drops significantly to only 100 requests per collection. This is because returning full HTML pages is much more resource intensive than returning structured JSON. If you need HTML for a large number of pages, you will need to create multiple smaller collections or manage the requests in smaller batches to stay within these platform constraints.
For large datasets, downloading individual JSON files is inefficient. RedCircle API provides destination tools that allow you to send result sets directly to cloud storage providers like Amazon S3, Google Cloud Storage, or Azure. You can configure these destinations once and then assign them to your collections. Alternatively, you can use the CSV link endpoints to get paginated download links. Each CSV file contains up to 1000 requests, making it easy to import the data into spreadsheets or business intelligence tools for analysis.
The platform provides a dedicated error log tool. You can list all error logs associated with your account to find failed API requests and see the specific error details. These logs are paginated with 10 entries per page. If a webhook failed to deliver a result set notification, you can also use the resend webhook tool. This allows you to test your endpoint connectivity without having to spend more credits to re run the entire collection, which saves both time and money during the setup phase.
You can update the parameters of a request, such as the TCIN or the request type, using the update request tool. However, this is only possible if the collection is not currently running. If a collection is in a queued or active state, the requests are locked to ensure data consistency. You must stop the collection first, apply your updates to the individual requests or bulk delete the incorrect ones and add new ones, and then restart the collection to process the updated set of product data.
If you do not have the Target specific item number, you should use the search functionality within the get target product data tool. By passing a search query, the API returns a list of matching products including their TCINs. Once you have the TCIN, you can use it for more targeted requests or add it to a batch collection for long term monitoring. This two step process of searching and then tracking is the standard workflow for building a comprehensive competitor monitoring list from scratch.

Alternatives to RedCircle API

Other tools that solve a similar problem. Ceven supports these too, so you can switch or run more than one at once.

Rainforest API logoRainforest APIBright Data logoBright DataOxylabs logoOxylabs

Try Ceven on your stack

Plug Ceven on top of the tools you already run. Connect RedCircle API and the rest of your stack, describe the outcome, and its agents handle the work end to end, days of it in minutes.

Get started for free