namestringRequired
The name of the Collection.
enabledbooleanOptional
Determines whether the Collection is enabled or not. Disabled Collections do not automatically start on their schedule. Parameter Values: true - Collection is enabled; false - Collection is disabled.
prioritystringOptional
Determines the priority of the Collection. When multiple Collections are queued, Rainforest API starts them in priority order. Parameter Values: highest; high; normal; low; lowest.
requests_typestringOptional
Determines whether this Collection is locked to only allow requests of the specified type to be added to it. Locking a Collection to a specific request type has several benefits including allowing Rainforest API to automatically choose the correct CSV fields, appropriate to the requests in the Collection, to be selected by default when exporting a Result Set in CSV mode. It can also help organize your account when you have many Collections set up. To allow any requests type to be added either omit requests_type entirely, or set it to mixed. When set, the requests_type_locked=true property is present when retrieving the Collection letting you know that the Collection is locked. If you leave the Collection as unlocked (i.e. by setting requests_type=mixed) then requests_type_locked=false will be present when retrieving the Collection and requests_type will be set to either mixed (in the case of the Collection containing mixed requests types) or a requests_type value automatically detected based on the type of requests that have been subsequently added to the Collection. Note: The requests_type cannot be changed after the Collection is created. For more information see the Collection Locking documentation. Valid values for requests_type are: Parameter Values: mixed - Allow requests of any type to be added to this Collection; product - Lock the Collection to allow only requests of type 'product' to be added; reviews - Lock the Collection to allow only requests of type 'reviews' to be added; offers - Lock the Collection to allow only requests of type 'offers' to be added; search - Lock the Collection to allow only requests of type 'search' to be added; bestsellers - Lock the Collection to allow only requests of type 'bestsellers' to be added; category - Lock the Collection to allow only requests of type 'category' to be added; deals - Lock the Collection to allow only requests of type 'deals' to be added; also_bought - Lock the Collection to allow only requests of type 'also_bought' to be added; stock_estimation - Lock the Collection to allow only requests of type 'stock_estimation' to be added; questions - Lock the Collection to allow only requests of type 'questions' to be added; question_answers - Lock the Collection to allow only requests of type 'question_answers' to be added; seller_profile - Lock the Collection to allow only requests of type 'seller_profile' to be added; seller_feedback - Lock the Collection to allow only requests of type 'seller_feedback' to be added; seller_products - Lock the Collection to allow only requests of type 'seller_products' to be added; reviewer_profile - Lock the Collection to allow only requests of type 'reviewer_profile' to be added; autocomplete - Lock the Collection to allow only requests of type 'autocomplete' to be added; author_page - Lock the Collection to allow only requests of type 'author_page' to be added; shop_by_look - Lock the Collection to allow only requests of type 'shop_by_look' to be added; asin_to_gtin - Lock the Collection to allow only requests of type 'asin_to_gtin' to be added; store - Lock the Collection to allow only requests of type 'store' to be added; charts - Lock the Collection to allow only requests of type 'charts' to be added; sales_estimation - Lock the Collection to allow only requests of type 'sales_estimation' to be added; formats_editions - Lock the Collection to allow only requests of type 'formats_editions' to be added.
schedule_typestringOptional
Determines the type of schedule the Collection uses. Parameter Values: monthly - Collection is run on a monthly schedule, use schedule_days_of_month to determine which days of the month and schedule_hours to determine which hours on those days; weekly - Collection is run on a weekly schedule, use schedule_days_of_week to determine which days of the week and schedule_hours to determine which hours on those days; daily - Collection is run on a daily schedule, use schedule_hours to determine which hours of the day the Collection is run; minutes - Collection is run on a Per X Minutes schedule, use schedule_minutes to determine the minutes frequency that the Collection is run. You may optionally use schedule_hours, schedule_days_of_week and schedule_days_of_month to refine the hours of the day, days of the week or days of the month that you wish the Per X Minutes schedule to be run; manual - Collection is run manually, use the Rainforest API Dashboard or the Start Collection API to start the Collection.
schedule_hoursarrayOptional
Determines the hours of the day the Collection is run when schedule_type=minutes, schedule_type=monthly, schedule_type=weekly or schedule_type=daily. Expressed as an array of integers between 0 (midnight) and 23 (11pm), i.e. [9,17] for 9am & 5pm. Note: Collection schedules are executed in the timezone set up on your profile. Note: When using schedule_hours in combination with schedule_type=minutes the Collection is executed at the per-minute frequency set in schedule_minutes throughout the hours set in schedule_hours. For example, if you set schedule_type=minutes, schedule_minutes=every_5_minutes and schedule_hours=[10,11,12] your Collection would be run every 5 minutes between the hours of 10am and 1pm. If you wish for a schedule_type=minutes Collection to be run continuously 24/7 then you should omit the schedule_hours parameter.
destination_idsarrayOptional
Specifies an array of Destination IDs (i.e. Amazon S3 Buckets, Google Cloud Storage buckets, Microsoft Azure Blob Storage or Alibaba Cloud OSS Buckets) that Result Sets from this Collection are uploaded to. Destination IDs can be retrieved through the Dashboard or via the Destinations API.
schedule_minutesstringOptional
Determines the minutes frequency that the Collection is run when schedule_type=minutes. Parameter Values: every_minute - Run the Collection every minute; every_5_minutes - Run the Collection every 5 minutes; every_10_minutes - Run the Collection every 10 minutes; every_15_minutes - Run the Collection every 15 minutes; every_20_minutes - Run the Collection every 20 minutes; every_25_minutes - Run the Collection every 25 minutes; every_30_minutes - Run the Collection every 30 minutes; every_hour - Run the Collection every hour. Note: When using schedule_type=minutes Collections are run at the selected frequency 24/7 unless specific hours are chosen in the schedule_hours parameter, specific days of the week are chosen in the schedule_days_of_week parameter or specific days of the month are chosen in the schedule_days_of_month parameter.
notification_emailstringOptional
The email address to send notifications to when new Result Sets are available for this Collection.
notification_as_csvbooleanOptional
Determines whether sends download links (in the email notification if notification_email is set, or in the body of the webhook POST if notification_webhook is set) for the Collection Result Sets CSV format, or not. To set the CSV fields included in the Result Set use the csv_fields parameter. If destination_ids are configured for this Collection then this setting determines whether Result Set files in CSV format are uploaded to the Destinations on Collection completion. Parameter Values: true - CSV output format enabled / sent; false - CSV output format disabled / not sent.
notification_as_jsonbooleanOptional
Determines whether Rainforest API sends download links (in the email notification if notification_email is set, or in the body of the webhook POST if notification_webhook is set) for the Collection Result Sets in JSON format, or not. If destination_ids are configured for this Collection then this setting determines whether Result Set files in JSON format are uploaded to the Destinations on Collection completion. Parameter Values: true - JSON output format enabled / sent; false - JSON output format disabled / not sent.
notification_webhookstringOptional
The URL Rainforest API will send a webhook POST to when new Result Sets are available for this Collection. Should be a fully qualified URL, i.e. https://yourserver.com/rainforestapi.
schedule_days_of_weekarrayOptional
Determines the days of the week the Collection is run when schedule_type=weekly or schedule_type=minutes, expressed as an array of integers where 0=Sunday and 6=Saturday, i.e. [0,2] for Sunday & Tuesday. Note: When using schedule_days_of_week in combination with schedule_type=minutes the Collection is executed at the per-minute frequency set in schedule_minutes on the days of the week set in schedule_days_of_week. For example, if you set schedule_type=minutes, schedule_minutes=every_5_minutes and schedule_days_of_week=[0,2] your Collection would be run every 5 minutes on Sunday & Tuesday. When schedule_type=minutes you can use either schedule_days_of_week or schedule_days_of_month, not both simultaneously.
schedule_days_of_montharrayOptional
Determines the days of the month the Collection is run when schedule_type=monthly or schedule_type=minutes, expressed as an array of integers, i.e. [1,3,20] for the 1st, 3rd and 20th of the month. Note: When using schedule_days_of_month in combination with schedule_type=minutes the Collection is executed at the per-minute frequency set in schedule_minutes on the days of the month set in schedule_days_of_month. For example, if you set schedule_type=minutes, schedule_minutes=every_5_minutes and schedule_days_of_month=[1,3,20] your Collection would be run every 5 minutes on the 1st, 3rd and 20th of the month. When schedule_type=minutes you can use either schedule_days_of_month or schedule_days_of_week, not both simultaneously.
notification_csv_fieldsstringOptional
Determines the fields that are returned when notification_as_csv=true. Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information see the CSV Fields Reference.
notification_as_jsonlinesbooleanOptional
Determines whether Rainforest API sends download links (in the email notification if notification_email is set, or in the body of the webhook POST if notification_webhook is set) for the Collection Result Sets in JSON Lines format, or not. If destination_ids are configured for this Collection then this setting determines whether Result Set files in JSON Lines format are uploaded to the Destinations on Collection completion. Parameter Values: true - JSON Lines output format enabled / sent; false - JSON Lines output format disabled / not sent.
