RedCircle

Delete a Collection and everything in it.

Delete one Request from a Collection. Requests can only be deleted while the Collection is not running. Call this sequentially rather than in parallel -- too many concurrent calls are answered 429; to clear many, use the clear-requests tool or delete and re-create the Collection.

Delete every Request in a Collection, leaving the Collection itself in place.

Delete a Destination. Collections referencing it stop uploading their Result Sets there.

Delete zipcodes from your account. The body is an ARRAY of objects, each naming a zipcode and the domain to remove it from.

Retrieve your RedCircle account information, including the request credits used and remaining on the current plan.

List or search Target's category hierarchy. Returns known-good category IDs to use with type=category Target Product Data requests. id, parent_id and search_term are mutually exclusive -- supply at most one.

List the Collections on your account, with filtering, sorting and pagination. 25 Collections are returned per page by default.

Retrieve one Collection, including whether it is currently running and how many Requests and Result Sets it holds.

List one page of a Collection's Requests, 1000 per page, pages starting at 1. The Collection's requests_page_count field says how many pages there are. Supply q to search the Requests and their custom_ids, or custom_id to match one exactly.

Retrieve download links for every Request in a Collection in CSV format, one link per page of results.

Retrieve download links for every Request in a Collection in JSON format, one link per page of results.

List every Result Set for a Collection. RedCircle retains Result Sets for 14 days, so download the data within that window.

Retrieve the results within one Result Set of a Collection.

Retrieve download links for one Result Set of a Collection in CSV format.

Retrieve download links for one Result Set of a Collection in JSON Lines format.

Ask RedCircle to re-send the webhook POST for one Result Set. Useful for debugging webhook connectivity without re-running the Collection.

Start a Collection running. The account must hold enough request credits for every Request in the Collection. Any schedule_type can be started as long as it is not already running.

Stop a Collection that is queued or running. Credits allocated to a queued Collection are refunded; a Collection already running is stopped without a refund.

Stop every Collection on the account that is currently queued or running, setting them back to idle. Credits allocated to a queued Collection are refunded; a Collection already running is stopped without a refund.

List the Destinations on your account -- the S3, Google Cloud Storage, Azure Blob Storage or Alibaba Cloud OSS buckets that Collection Result Sets are uploaded to. 10 are returned per page.

List the Error Logs on your account, which record requests that failed and why. 10 are returned per page.

List the products in a Target category by category ID, with the same sorting, delivery-type, rating and facet filters as search. Category IDs come from the list-and-search-categories tool. Supply `category_id`, or a Target category `url` (which overrides every other parameter).

Retrieve a single Target product's details -- title, brand, pricing, promotions, ratings, images, specifications and variants -- by TCIN (Target item ID), DPCI, GTIN/ISBN/UPC, or a Target product-page URL. Supply one of `tcin`, `dpci`, `gtin` or `url`: `url` overrides the other three, and `gtin` overrides `tcin` and `dpci`.

Retrieve customer reviews for a Target product, filtered by reviewer type, star rating and media type, and sorted. Identify the product by `tcin`, `dpci`, `gtin` or a Target product-page `url`.

Search Target for products by search term, with optional category, sorting, delivery-type, rating and facet filters, and pagination. Supply `search_term`, or a Target search-results `url` (which overrides every other parameter).

Retrieve in-store stock for a Target product across stores near a zipcode -- up to 20 stores within a 50 mile radius. Identify the product by `tcin`, `dpci`, `gtin` or `url`.

List the zipcodes set up on your account. A maximum of 10 are returned per page.

Create a Collection, which runs up to 15,000 Requests on a schedule (100 when its Requests set include_html=true). An account may hold up to 10,000 Collections.

Create a Destination -- an S3, S3-compatible, Google Cloud Storage, Azure Blob Storage or Alibaba Cloud OSS bucket that Collection Result Sets are uploaded to.

Add zipcodes to your account. The body is an ARRAY of objects, each naming a zipcode and the domain to use it on.

Update a Collection's fields, and/or add Requests to it. These are the same endpoint: send the Collection's own fields to update it, or a `requests` array (up to 1000 per call) to add Requests. A Collection holds at most 15,000 Requests. Requests can only be added while the Collection is not running.

Update one Request inside a Collection. Requests can only be updated while the Collection is not running. Call this sequentially rather than in parallel -- too many concurrent calls are answered 429.

Update a Destination. It takes the same fields as creating one.