NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

RedCircle API

redcircle_api

RedCircle API is the real-time Target product data API for accessing Target product catalog, reviews, and category data.

Developer ToolsEcommerceWeb del proveedor
Acciones
32
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (32)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add ZipcodesREDCIRCLE_API_ADD_ZIPCODESAcción

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.

Parámetros de entrada

  • zipcodesobject[]Obligatorio

    Array of zipcode entries to add. Each entry specifies a zipcode and the domain where it will be used.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clear Collection RequestsREDCIRCLE_API_CLEAR_COLLECTION_REQUESTSAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to clear

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CollectionREDCIRCLE_API_CREATE_COLLECTIONAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Collection identifier name.

  • enabledboolean

    Activation status; defaults to false if omitted.

  • prioritystringenum

    Queue priority level.

    highesthighnormallowlowest
  • requests_typestringenum

    Lock type - 'mixed', 'product', 'reviews', 'search', 'category', 'store_stock' (cannot be modified after creation).

    mixedproductreviewssearchcategorystore_stock
  • schedule_typestringenum

    Schedule pattern - 'monthly', 'weekly', 'daily', 'minutes', or 'manual'.

    monthlyweeklydailyminutesmanual
  • schedule_hoursinteger[]

    Hours 0-23 for daily/weekly/monthly schedules.

  • destination_idsstring[]

    Cloud storage bucket identifiers for result uploads.

  • schedule_minutesstringenum

    Frequency - 'every_minute', 'every_5_minutes', up to 'every_hour'.

    every_minuteevery_5_minutesevery_10_minutesevery_15_minutesevery_30_minutesevery_hour
  • notification_emailstring

    Email address for completion notifications.

  • notification_as_csvboolean

    Enable CSV format result delivery.

  • notification_as_jsonboolean

    Enable JSON format result delivery.

  • notification_webhookstring

    Fully qualified URL for webhook POST notifications.

  • schedule_days_of_weekinteger[]

    Days 0-6 (Sunday-Saturday) for weekly/minute schedules.

  • schedule_days_of_monthinteger[]

    Integer days (e.g., [1,20]) for monthly/minute schedules.

  • notification_csv_fieldsstring

    Comma-separated CSV field list (dot notation format).

  • notification_as_jsonlinesboolean

    Enable JSON Lines format result delivery.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DestinationREDCIRCLE_API_CREATE_DESTINATIONAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Destination identifier/name.

  • typestringObligatorioenum

    Storage provider type. Options: s3 (Amazon S3), gcs (Google Cloud Storage), azure (Azure Blob Storage), oss (Alibaba OSS), s3compatible (S3-compatible storage).

    s3gcsazureosss3compatible
  • enabledbooleanObligatorio

    Activation status. If true, a connectivity test will be performed by uploading and deleting a test file.

  • s3_regionstring

    Region identifier for S3-compatible storage. Optional when type='s3compatible'.

  • s3_endpointstring

    S3-compatible endpoint URL. Required when type='s3compatible'.

  • oss_region_idstring

    Alibaba region identifier. Required when type='oss'.

  • gcs_access_keystring

    Google Cloud interoperable access key. Required when type='gcs'.

  • gcs_secret_keystring

    Google Cloud interoperable secret key. Required when type='gcs'.

  • oss_access_keystring

    Alibaba Cloud RAM user access key. Required when type='oss'.

  • oss_secret_keystring

    Alibaba Cloud RAM user secret key. Required when type='oss'.

  • s3_bucket_namestring

    S3 bucket name. Required when type='s3'.

  • s3_path_prefixstring

    Path prefix for S3 uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='s3' or type='s3compatible'.

  • gcs_bucket_namestring

    GCS bucket identifier. Required when type='gcs'.

  • gcs_path_prefixstring

    Path prefix for GCS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='gcs'.

  • oss_bucket_namestring

    Alibaba OSS bucket name. Required when type='oss'.

  • oss_path_prefixstring

    Path prefix for OSS uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='oss'.

  • s3_access_key_idstring

    AWS access key ID. Required when type='s3'.

  • azure_account_keystring

    Azure storage account key. Required when type='azure'.

  • azure_path_prefixstring

    Path prefix for Azure uploads. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%. Optional when type='azure'.

  • azure_account_namestring

    Azure storage account name. Required when type='azure'.

  • azure_container_namestring

    Azure blob container name. Required when type='azure'.

  • s3_secret_access_keystring

    AWS secret access key. Required when type='s3'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create RequestsREDCIRCLE_API_CREATE_REQUESTSAcción

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.

Parámetros de entrada

  • requestsobject[]Obligatorio

    JSON array containing request objects. Maximum 1,000 requests per call. Collections have a 15,000 request maximum (100 if include_html=true).

  • collection_idstringObligatorio

    The unique identifier of the target collection

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CollectionREDCIRCLE_API_DELETE_COLLECTIONAcción

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

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to delete. Note: Collection cannot be deleted while actively running.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete DestinationREDCIRCLE_API_DELETE_DESTINATIONAcción

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

Parámetros de entrada

  • destination_idstringObligatorio

    The unique identifier of the destination to be removed

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Request from CollectionREDCIRCLE_API_DELETE_REQUESTAcción

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.

Parámetros de entrada

  • request_idstringObligatorio

    The unique identifier of the specific request to remove from the collection.

  • collection_idstringObligatorio

    The unique identifier for the collection containing the request. Collections must not be actively running to delete requests.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Requests In BulkREDCIRCLE_API_DELETE_REQUESTS_BULKAcción

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.

Parámetros de entrada

  • request_idsstring[]Obligatorio

    An array of Request ID strings to be deleted from the collection. Bulk deletion is typically quicker than sequential calls and helps avoid rate-limit errors.

  • collection_idstringObligatorio

    The identifier of the collection containing requests to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ZipcodesREDCIRCLE_API_DELETE_ZIPCODESAcción

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

Parámetros de entrada

  • zipcodesobject[]Obligatorio

    List of zipcode/domain pairs to remove from the account. Each entry must include both zipcode and domain fields.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Account InformationREDCIRCLE_API_GET_ACCOUNTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CollectionREDCIRCLE_API_GET_COLLECTIONAcción

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

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Requests CSV LinksREDCIRCLE_API_GET_REQUESTS_CSV_LINKSAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The ID of the collection for which to retrieve CSV download links.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Requests JSON LinksREDCIRCLE_API_GET_REQUESTS_JSON_LINKSAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to retrieve requests from.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Result Set CSVREDCIRCLE_API_GET_RESULT_SET_CSVAcción

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.

Parámetros de entrada

  • csv_fieldsstring

    Comma-separated list of fields to include in the CSV output. Use dot notation for nested fields (e.g., 'field1,field2,nested.field3'). If not provided, all fields are included.

  • collection_idstringObligatorio

    The unique identifier of the collection.

  • result_set_idstringObligatorio

    The unique identifier of the result set within the collection.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Result Set JSONREDCIRCLE_API_GET_RESULT_SET_JSONAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection.

  • result_set_idstringObligatorio

    The unique identifier of the result set within the collection.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Result Set JSON LinesREDCIRCLE_API_GET_RESULT_SET_JSONLINESAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection.

  • result_set_idstringObligatorio

    The unique identifier of the result set within the collection.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Target Product DataREDCIRCLE_API_GET_TARGET_PRODUCT_DATAAcción

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.

Parámetros de entrada

  • pageinteger

    Page number for pagination control of result sets.

  • tcinstring

    Target's unique product identifier (Target.com Item Number) for specific product lookup. Required when type='product'.

  • typestringObligatorioenum

    Specifies the data type to retrieve. Valid values: 'search' for product search results, 'product' for specific product details, 'reviews' for product reviews, 'category' for category listings.

    searchproductreviewscategory
  • sort_bystring

    Ordering method for search results (e.g., 'best_seller').

  • category_idstring

    Target category identifier for category listings. Required when type='category' and 'url' is not specified.

  • search_termstring

    Search query for product discovery (e.g., 'highlighter pens', 'laptop'). Required when type='search'.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CategoriesREDCIRCLE_API_LIST_CATEGORIESAcción

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.

Parámetros de entrada

  • idstring

    Single category identifier to retrieve specific category details. Cannot be used with parent_id or search_term.

  • parent_idstring

    Parent category ID to retrieve child categories. Cannot be used with id or search_term.

  • search_termstring

    Search phrase to filter across category hierarchy (e.g., 'appliances'). Cannot be used with id or parent_id.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List CollectionsREDCIRCLE_API_LIST_COLLECTIONSAcción

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.

Parámetros de entrada

  • pageinteger

    Page number for pagination (defaults to 1)

  • statusstringenum

    Filter by Collection status: 'all', 'idle', 'queued', or 'running' (defaults to all)

    allidlequeuedrunning
  • sort_bystringenum

    Sort collections by: 'created_at', 'last_run', 'name', 'priority', or 'status'

    created_atlast_runnameprioritystatus
  • page_sizeinteger

    Results per page; defaults to 25, maximum 1000

  • search_termstring

    Limits results to Collections matching the search term in their name

  • search_typestringenum

    Determines search matching strategy: 'contains' (default), 'starts_with', 'ends_with', or 'exact'

    containsstarts_withends_withexact
  • created_afterstring

    Filter Collections created after specified timestamp (ISO 8601 format)

  • created_beforestring

    Filter Collections created before specified timestamp (ISO 8601 format)

  • destination_idstring

    Filter to Collections with specified destination ID

  • last_run_afterstring

    Filter Collections by last run date after specified timestamp (ISO 8601 format)

  • sort_directionstringenum

    Sort direction: 'ascending' (default) or 'descending'

    ascendingdescending
  • last_run_beforestring

    Filter Collections by last run date before specified timestamp (ISO 8601 format)

  • only_with_resultsboolean

    Filter to return only Collections containing result sets

  • only_without_resultsboolean

    Filter to return only Collections without result sets

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List DestinationsREDCIRCLE_API_LIST_DESTINATIONSAcción

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.

Parámetros de entrada

  • pageinteger

    Set the page number of Destinations to return. Defaults to page=1. 10 Destinations are returned per page.

  • sort_bystringenum

    Sort destinations by 'type' or 'name'.

    typename
  • search_termstring

    Filters results to destinations containing this term in their name.

  • sort_directionstringenum

    Sort direction: 'ascending' (default) or 'descending'.

    ascendingdescending

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Error LogsREDCIRCLE_API_LIST_ERROR_LOGSAcción

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.

Parámetros de entrada

  • pageinteger

    Set the page number of error logs to return, defaults to page=1. 10 error logs are returned per page.

  • sort_bystring

    The sort order to apply to the results. Valid values are 'date' (to sort by error log date) or 'count' (to sort by error log count).

  • search_termstring

    Limits the error logs returned to just those containing the search_term in their parameters property.

  • sort_directionstring

    The sort direction to return results. Valid values are 'descending' or 'ascending' (the default). Use in conjunction with the sort_by parameter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Requests by PageREDCIRCLE_API_LIST_REQUESTS_BY_PAGEAcción

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

Parámetros de entrada

  • pageintegerObligatorio

    Page number for pagination (starts at 1, max 1000 requests per page)

  • collection_idstringObligatorio

    The collection identifier

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Result SetsREDCIRCLE_API_LIST_RESULT_SETSAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to retrieve result sets for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ZipcodesREDCIRCLE_API_LIST_ZIPCODESAcción

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.

Parámetros de entrada

  • pageinteger

    Specifies which page of results to return; max 10 results per page. Must be >= 1.

  • domainstring

    Filters results to zipcodes associated with a specific domain.

  • search_termstring

    Limits the returned zipcodes to just those containing the search_term (e.g., search_term=455).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Resend WebhookREDCIRCLE_API_RESEND_WEBHOOKAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier for the collection

  • result_set_idstringObligatorio

    The unique identifier for the result set

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start CollectionREDCIRCLE_API_START_COLLECTIONAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to start. Must be a valid collection ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Stop All CollectionsREDCIRCLE_API_STOP_ALL_COLLECTIONSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Stop CollectionREDCIRCLE_API_STOP_COLLECTIONAcción

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.

Parámetros de entrada

  • collection_idstringObligatorio

    The unique identifier of the collection to stop. The collection must be in queued or running state.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CollectionREDCIRCLE_API_UPDATE_COLLECTIONAcción

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.

Parámetros de entrada

  • namestring

    The name of the Collection

  • enabledboolean

    Determines if the Collection runs automatically on schedule. Set to true to enable or false to disable.

  • prioritystring

    Collection execution priority when queued. Valid values: highest, high, normal, low, lowest.

  • collection_idstringObligatorio

    The unique identifier of the collection to update

  • requests_typestring

    Lock collection to specific request types. Valid values: mixed, product, reviews, search, category, store_stock.

  • schedule_typestring

    Determines the type of schedule. Valid values: monthly, weekly, daily, minutes, manual.

  • schedule_hoursinteger[]

    Hours when collection runs where 0=midnight and 23=11pm. Valid values: 0-23.

  • destination_idsstring[]

    Specifies an array of Destination IDs that Result Sets are uploaded to (S3, GCS, Azure, Alibaba buckets).

  • schedule_minutesstring

    Frequency for minute-based scheduling. Valid values: every_minute, every_5_minutes, every_10_minutes, every_15_minutes, every_20_minutes, every_25_minutes, every_30_minutes, every_hour. Only applicable when schedule_type is 'minutes'.

  • notification_emailstring

    The email address to send notifications to when new Result Sets are available.

  • notification_as_csvboolean

    Enable CSV format in notifications. Set to true to enable or false to disable.

  • notification_as_jsonboolean

    Enable JSON format in notifications. Set to true to enable or false to disable.

  • notification_webhookstring

    The URL RedCircle API will send a webhook POST to. Must be a fully qualified HTTPS URL.

  • schedule_days_of_weekinteger[]

    Array of days of the week (as integers) to run the Collection where 0=Sunday and 6=Saturday. Valid values: 0-6. Only applicable when schedule_type is 'weekly'.

  • schedule_days_of_monthinteger[]

    Array of days of the month to run the Collection. Valid values: 1-31. Only applicable when schedule_type is 'monthly'.

  • notification_csv_fieldsstring

    CSV fields to include in results using comma-separated dot notation (e.g., 'field1,field2.subfield').

  • notification_as_jsonlinesboolean

    Enable JSON Lines format in notifications. Set to true to enable or false to disable.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update DestinationREDCIRCLE_API_UPDATE_DESTINATIONAcción

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.

Parámetros de entrada

  • namestring

    The name of the destination

  • typestringenum

    Destination storage provider type

    s3gcsazureosss3compatible
  • enabledboolean

    Determines if the destination receives collection uploads. When enabling a previously disabled destination or updating credentials, RedCircle API will perform a connectivity test.

  • s3_regionstring

    Region identifier (e.g., eu-west-1, us-east-1, auto)

  • s3_endpointstring

    Endpoint URL. Required for s3compatible type (e.g., https://ams3.digitaloceanspaces.com)

  • oss_region_idstring

    Alibaba Cloud OSS region ID (e.g., oss-cn-hangzhou, oss-us-west-1)

  • destination_idstringObligatorio

    The unique identifier of the destination to update

  • gcs_access_keystring

    Google Cloud Storage interoperable storage access key

  • gcs_secret_keystring

    Google Cloud Storage interoperable storage secret key

  • oss_access_keystring

    Alibaba Cloud OSS RAM user access key

  • oss_secret_keystring

    Alibaba Cloud OSS RAM user secret key

  • s3_bucket_namestring

    Target S3 bucket name

  • s3_path_prefixstring

    Path prefix for uploaded files. Supports tokens: %COLLECTION_ID%, %COLLECTION_NAME%, %RESULT_SET_ID%, %DATE%

  • gcs_bucket_namestring

    Google Cloud Storage bucket name

  • gcs_path_prefixstring

    Path prefix with token support for GCS uploads

  • oss_bucket_namestring

    Alibaba Cloud OSS bucket name

  • oss_path_prefixstring

    Path prefix with token support for OSS uploads

  • s3_access_key_idstring

    AWS access key ID. Required for S3 and S3-compatible destinations.

  • azure_account_keystring

    Azure account access key

  • azure_path_prefixstring

    Path prefix with token support for Azure uploads

  • azure_account_namestring

    Azure storage account name

  • azure_container_namestring

    Azure blob storage container name

  • s3_secret_access_keystring

    AWS secret access key. Required for S3 and S3-compatible destinations.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update RequestREDCIRCLE_API_UPDATE_REQUESTAcción

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.

Parámetros de entrada

  • tcinstring

    Target product identifier (TCIN) for Target Product Data API requests

  • typestring

    Type of the request (e.g., 'product' for Target Product Data API)

  • request_idstringObligatorio

    The identifier of the request to update

  • collection_idstringObligatorio

    The identifier of the collection containing the request

  • additional_paramsobject

    Additional parameters matching Target Product Data API specification. Any valid API parameters can be included here.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not