Skip to main content
Countdown API logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: COUNTDOWN_API
  • Version: 20261101_00

Tools

Slug: COUNTDOWN_API_CLEAR_ALL_REQUESTSClears all requests from an idle collection to reset it before adding new requests. The response may include updated collection details.

Input Parameters

string
required
The unique 8-character alphanumeric ID of the collection to clear. Get this from list_collections or create_collection actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_COLLECTIONS_CREATE_COLLECTIONTool to create a new collection. Use when you need to batch and orchestrate multiple requests on a schedule.

Input Parameters

string
required
Collection name
boolean
Enable or disable scheduled runs
string ("highest" | "high" | "normal" | "low" | "lowest")
Collection priority
string ("mixed" | "search" | "product" | "reviews" | "seller_profile" | "seller_feedback" | "autocomplete" | "deals")
Lock collection to a specific request type; cannot be changed after creation. Use ‘mixed’ to allow any request type.
string ("monthly" | "weekly" | "daily" | "minutes" | "manual")
Run schedule type
array
Hours (0-23) to run
array
Destination IDs to upload results to
string ("every_minute" | "every_2_minutes" | "every_5_minutes" | "every_10_minutes" | "every_15_minutes" | "every_20_minutes" | "every_25_minutes" | "every_30_minutes" | "every_hour")
Minute interval when schedule_type=‘minutes’. Determines how frequently the collection runs within each hour.
string
Email to send notifications to
boolean
Output/upload results as CSV
boolean
Output/upload results as JSON
string
Webhook URL to POST when results are available
array
Days of week (0=Sun … 6=Sat) for weekly schedules
array
Days of month (1-31) for monthly schedules
string
Comma-separated field list when CSV enabled
boolean
Output/upload results as JSON Lines

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_COLLECTIONS_GET_COLLECTIONTool to retrieve details for a single collection by ID. Use when you need collection metadata and counts for a given collection ID.

Input Parameters

string
required
Unique 8-character hexadecimal collection identifier (e.g., ‘51AE51AB’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_COLLECTIONS_LIST_COLLECTIONSTool to list all collections for the authenticated account. Use when you need to retrieve paginated collections with filtering, sorting, and timing constraints.

Input Parameters

integer
Page number to retrieve (default is 1).
string ("all" | "idle" | "queued" | "running")
Filter by status. Default is ‘all’.
string ("created_at" | "last_run" | "name" | "priority" | "status")
Field to sort by (default ‘name’).
integer
Results per page (default 25, maximum 1000).
string
Limit results to collections whose name contains this term.
string ("contains" | "starts_with" | "ends_with" | "exact")
How to match the search_term. One of: contains, starts_with, ends_with, exact.
string
Only collections created after this ISO UTC timestamp (ISO 8601).
string
Only collections created before this ISO UTC timestamp (ISO 8601).
string
Only collections with the specified destination id.
string
Only collections with last run after this ISO UTC timestamp (ISO 8601).
string ("ascending" | "descending")
Sort direction (default ‘ascending’).
string
Only collections with last run before this ISO UTC timestamp (ISO 8601).
boolean
Only return collections that have result sets available.
boolean
Only return collections with no result sets available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_COLLECTIONS_START_COLLECTIONStart processing a collection’s queued requests on the Countdown API. Use this tool to manually trigger a collection to begin executing its requests. The collection must have at least one request added to it before it can be started. You need sufficient API credits to run all requests in the collection. Prerequisites: - Collection must exist (use List Collections or Create Collection first) - Collection must have at least one request added - Sufficient API credits available for the number of requests - Collection must not already be running

Input Parameters

string
required
The unique identifier of the collection to start. Must be a valid collection ID obtained from creating or listing collections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_COLLECTIONS_UPDATE_COLLECTIONUpdate an existing collection’s settings. Use this to modify collection properties like name, schedule, priority, notification settings, or enabled status. The collection_id must be obtained from list_collections or create_collection. Only specified fields are updated; omitted fields retain their current values.

Input Parameters

string
New name for the collection
boolean
Enable or disable scheduled runs
string ("highest" | "high" | "normal" | "low" | "lowest")
Collection priority
string
required
ID of the collection to update (obtained from list_collections or create_collection)
string ("mixed" | "search" | "product" | "reviews" | "seller profile" | "seller feedback" | "autocomplete" | "deals")
Lock collection to a specific request type; cannot be changed after creation
string ("monthly" | "weekly" | "daily" | "minutes" | "manual")
Run schedule type
array
Hours (0-23) to run
array
Destination IDs to upload results to
string ("every minute" | "every 5 minutes" | "every 10 minutes" | "every 15 minutes" | "every 20 minutes" | "every 25 minutes" | "every 30 minutes" | "every hour")
Minute interval when schedule_type=‘minutes’
string
Email to send notifications to
boolean
Output/upload results as CSV
boolean
Output/upload results as JSON
string
Webhook URL to POST when results are available
array
Days of week (0=Sun…6=Sat) for weekly schedules
array
Days of month (1-31) for monthly schedules
string
Comma-separated field list when CSV enabled
boolean
Output/upload results as JSON Lines

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_CORE_API_SEND_REQUESTTool to fetch eBay autocomplete suggestions. Use when needing search-term-based suggestions from Countdown API.

Input Parameters

string
The type of request. Must be “autocomplete” to retrieve autocomplete suggestions.
string
eBay domain to retrieve autocomplete suggestions from. Supported domains include ebay.com, ebay.co.uk, ebay.de, ebay.fr, ebay.com.au, ebay.ca, etc.
string
required
The search term to get autocomplete suggestions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_CREATE_COLLECTION_REQUESTTool to create new requests within a collection for bulk eBay data retrieval. Use when you need to add search, product, reviews, or other eBay data queries to a collection that will be executed on schedule. Collections must be in ‘idle’ status to accept new requests.

Input Parameters

array
required
Array of request objects to add to the collection. Maximum 1,000 requests per call. Collections support up to 15,000 total requests
string
required
The 8-character alphanumeric ID of the collection to add requests to. Collection must be in ‘idle’ status. Use ‘List Collections’ to find available collection IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_CREATE_DESTINATIONCreates a cloud storage destination where batch result sets will be automatically uploaded. Supports Amazon S3, S3-compatible services (MinIO, DigitalOcean Spaces), Google Cloud Storage, Microsoft Azure Blob Storage, and Alibaba Cloud OSS. When enabled=true, the API validates credentials by uploading and deleting a test file. Set enabled=false to create the destination without credential validation.

Input Parameters

string
required
A descriptive name to identify this destination.
string ("s3" | "s3compatible" | "gcs" | "azure" | "oss")
required
Cloud storage provider type: ‘s3’ for Amazon S3, ‘s3compatible’ for S3-compatible services (MinIO, DigitalOcean Spaces), ‘gcs’ for Google Cloud Storage, ‘azure’ for Microsoft Azure Blob Storage, ‘oss’ for Alibaba Cloud OSS.
boolean
required
Whether automatic uploads to this destination are active. Set to false to create destination without validating credentials.
string
AWS region or S3-compatible service region (e.g., ‘us-east-1’). Optional for S3-compatible services.
string
S3-compatible service endpoint URL (e.g., ‘https://minio.example.com:9000’). Required when type is ‘s3compatible’.
string
Alibaba Cloud OSS region ID (e.g., ‘oss-cn-hangzhou’, ‘oss-us-east-1’). Required when type is ‘oss’.
string
Google Cloud Storage interoperable storage access key (HMAC key). Required when type is ‘gcs’.
string
Google Cloud Storage interoperable storage secret key (HMAC secret). Required when type is ‘gcs’.
string
Alibaba Cloud RAM user access key. Required when type is ‘oss’.
string
Alibaba Cloud RAM user secret key. Required when type is ‘oss’.
string
Name of the S3 bucket to upload files to. Required when type is ‘s3’ or ‘s3compatible’.
string
Optional path prefix for uploaded files. Supports replacement tokens: %BATCH_ID%, %BATCH_NAME%, %RESULT_SET_ID%, %DATE%.
string
Name of the GCS bucket to upload files to. Required when type is ‘gcs’.
string
Optional path prefix for uploaded files. Supports replacement tokens: %BATCH_ID%, %BATCH_NAME%, %RESULT_SET_ID%, %DATE%.
string
Name of the Alibaba Cloud OSS bucket to upload files to. Required when type is ‘oss’.
string
Optional path prefix for uploaded files. Supports replacement tokens: %BATCH_ID%, %BATCH_NAME%, %RESULT_SET_ID%, %DATE%.
string
AWS IAM access key ID. Required when type is ‘s3’ or ‘s3compatible’.
string
Azure Storage account access key. Required when type is ‘azure’.
string
Optional path prefix for uploaded files. Supports replacement tokens: %BATCH_ID%, %BATCH_NAME%, %RESULT_SET_ID%, %DATE%.
string
Azure Storage account name. Required when type is ‘azure’.
string
Name of the Azure Blob container to upload files to. Required when type is ‘azure’.
string
AWS IAM secret access key. Required when type is ‘s3’ or ‘s3compatible’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_DELETE_COLLECTIONTool to delete a collection and its configuration by ID. Use when you need to remove an existing, non-running collection.

Input Parameters

string
required
ID of the collection to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_DELETE_DESTINATIONTool to delete a destination by ID. Use when you need to remove an existing destination.

Input Parameters

string
required
ID of the destination to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_DELETE_SINGLE_REQUESTDelete a specific request from a Countdown API collection by its ID. Use this to remove individual requests that are no longer needed. The collection must not be running when deleting requests.

Input Parameters

string
required
The unique identifier of the request to delete from the collection. Obtain this from the ‘List Requests Paged’ action.
string
required
The unique identifier of the collection containing the request to delete. Obtain this from the ‘List Collections’ or ‘Create Collection’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_DESTINATIONS_LIST_DESTINATIONSTool to list all destinations configured for the account. Use when you need to inspect or paginate through configured destinations.

Input Parameters

integer
Page number to return; 10 destinations per page
string ("type" | "name")
Sort field; valid values: ‘type’ or ‘name’; use with sort_direction
string
Filter results to destinations whose names contain this term
string ("ascending" | "descending")
Sort direction; valid values: ascending or descending; use with sort_by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_FIND_COLLECTION_REQUESTSTool to find requests in a collection by custom_id or search query. Use when you need to search for specific requests within a collection using either an exact custom_id match or a text search query.

Input Parameters

string
Search query to find requests. Searches across request fields and custom_id. Mutually exclusive with ‘custom_id’ parameter - provide either custom_id or q, not both.
integer
1-indexed page number of matching results to retrieve. Each page returns up to 1000 requests. Start with page 1 and check requests_page_count in the response for total pages.
string
Find requests with this exact custom_id. Mutually exclusive with ‘q’ parameter - provide either custom_id or q, not both.
string
required
The 8-character alphanumeric ID of the collection to search. Use ‘List Collections’ to find available collection IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_GET_ACCOUNTTool to retrieve account usage and current platform status. Use when needing to check plan, usage, and quota details for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_LIST_ERROR_LOGSList account error logs with pagination. Returns details about failed API requests and their reported errors.

Input Parameters

integer
Page number to retrieve (1-indexed). Use page_count_total from the response to determine the total number of pages available.
integer
Number of error log entries to return per page (default 25, maximum 1000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_REQUESTS_EXPORT_CSVExport all requests from a collection as downloadable CSV files. Returns URLs to CSV files containing the request data. Use this tool when you need to bulk export or download collection request data in CSV format. The response includes paginated download links if the collection has many requests. Collections with no requests will return an empty pages array.

Input Parameters

string
required
The ID of the collection whose requests you want to export as CSV.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_REQUESTS_EXPORT_JSONExport a collection’s requests as JSON, returning per-page download links for the exported files.

Input Parameters

string
required
ID of the collection to export requests from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_REQUESTS_UPDATE_SINGLE_REQUESTTool to modify parameters of an existing request in a collection. Use when the collection is not running and you need to update eBay Product Data API parameters.

Input Parameters

object
required
Complete request parameters conforming to the eBay Product Data API schema. Must include required fields: ‘type’ (product/search/reviews/seller_profile/seller_feedback/category/autocomplete/deals), ‘ebay_domain’ (e.g., ebay.com, ebay.co.uk, ebay.de). Type-specific parameters: for ‘product’ use ‘epid’; for ‘search’ use ‘search_term’; etc.
string
required
ID of the specific request to update within the collection.
string
required
ID of the collection containing the request to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_RESULTS_GET_RESULT_SETTool to retrieve a collection run’s result set payload. Use after a collection run completes to fetch metadata and download links.

Input Parameters

string
required
Unique identifier of the collection containing the result set. Obtain from List Collections or Create Collection actions.
integer
required
Numeric ID of the result set to retrieve. Obtain from List Result Sets action or from collection’s next_result_set_id minus 1 after a run completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_RESULTS_LIST_RESULT_SETSTool to list result sets produced by a collection. Use when you need to retrieve all summary status of result sets generated by a collection within the 14-day retention window.

Input Parameters

string
required
Unique identifier of the collection to list result sets for. Obtain this from the List Collections action or from a previously created collection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_RESULTS_RESEND_RESULT_SET_WEBHOOKResend the webhook notification for a collection’s result set. Use this tool to retry webhook delivery when the original webhook POST failed or timed out. The collection must have a notification_webhook URL configured (either on the collection itself or on the account profile). Result sets are only available for 14 days after creation. Prerequisites: - Collection must exist with a valid notification_webhook URL configured - Result set must exist and not be expired (14-day retention) - Use List Result Sets to find valid result_set_id values

Input Parameters

string
required
The unique 8-character alphanumeric identifier of the collection containing the result set. Obtain this from List Collections or Create Collection actions.
integer
required
The numeric ID of the result set within the collection (must be >= 1). Each time a collection runs, it generates a new result set with an incrementing ID. Obtain valid IDs from List Result Sets action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_STOP_ALL_COLLECTIONSTool to stop all collections. Use when you need to halt any running or queued collections after reviewing operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_STOP_COLLECTIONTool to stop (pause) a single collection’s processing by ID. Use when you need to halt a running or queued collection after confirming the target collection ID.

Input Parameters

string
required
The unique identifier of the collection to stop. The collection must be in ‘running’ or ‘queued’ status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COUNTDOWN_API_UPDATE_DESTINATIONTool to update a destination’s configuration by ID. Use after creating or retrieving a destination to modify its settings.

Input Parameters

string
Destination name
string ("s3" | "s3compatible" | "gcs" | "azure" | "oss")
Destination type
boolean
Whether uploads are active for this destination
string
S3 region (optional when type is s3compatible)
string
S3 endpoint URL (required when type is s3compatible)
string
OSS region ID (required when type is oss)
string
required
Unique identifier of the destination to update. Obtain from list_destinations or create_destination.
string
GCS access key (required when type is gcs)
string
GCS secret key (required when type is gcs)
string
OSS access key (required when type is oss)
string
OSS secret key (required when type is oss)
string
S3 bucket name (required when type is s3 or s3compatible)
string
S3 path prefix (optional); supports tokens %collection_id%, %collection_name%, %result_set_id%, %date%
string
GCS bucket name (required when type is gcs)
string
GCS path prefix (optional); supports tokens %collection_id%, %collection_name%, %result_set_id%, %date%
string
OSS bucket name (required when type is oss)
string
OSS path prefix (optional); supports tokens %collection_id%, %collection_name%, %result_set_id%, %date%
string
S3 access key id (required when type is s3 or s3compatible)
string
Azure account key (required when type is azure)
string
Azure path prefix (optional); supports tokens %collection_id%, %collection_name%, %result_set_id%, %date%
string
Azure account name (required when type is azure)
string
Azure container name (required when type is azure)
string
S3 secret access key (required when type is s3 or s3compatible)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not