Overview

collections api collections allow you to schedule requests to run en masse you can add up to 15,000 requests (a request is simply a call to the home depot product data api) per collection (100 per collection if using the include html=true request parameter) and you can have up to 10,000 collections on your account at any one time collections can be scheduled to run monthly, weekly, daily, hourly or run manually on demand and you can get result sets in json, json lines or csv formats bigbox api can also call a webhook https //docs trajectdata com/bigboxapi/collections api/collections/webhook on your side when collections complete collection & result set expiry collections will be deleted from your account after 2 months of inactivity i e you must start https //docs trajectdata com/bigboxapi/collections api/collections/start a collection at least once every two months for it to remain active result sets are available for download for 14 days so your app should download and process the result set data within this 14 day window the bigbox api collections api allows you to create https //docs trajectdata com/bigboxapi/collections api/collections/create , update https //docs trajectdata com/bigboxapi/collections api/collections/update and delete https //docs trajectdata com/bigboxapi/collections api/collections/delete collections you can also use the collections api to add requests https //docs trajectdata com/bigboxapi/collections api/requests/create to a collection and retrieve result sets https //docs trajectdata com/bigboxapi/collections api/results/list the collections api is free of charge there is no charge for usage of the collections api and requests to it will not decrement your plans monthly requests quota when you start https //docs trajectdata com/bigboxapi/collections api/collections/start a collection the requests within the collection will be charged as per requests made via the home depot product data api https //docs trajectdata com/bigboxapi/homedepot product data api so a collection with 200 requests in it, run once, will cost 200 credits the bigbox api dashboard also provides a visual editor https //app bigboxapi com/collections for collections and is a great way to get familiar with the key concepts in collections before creating them programmatically through the collections api collections terminology to help you get started here's some of the terminology you'll encounter whilst interacting with collections on bigbox api collection you can have 10,000 collections active on your account at any one time a collection holds (up to 15,000) requests a collection can have a schedule and can be set to start automatically or manually when a collection is started, its requests are run through the bigbox api home depot product data api and a result set is generated collections can notify you when a new result set is available via email or webhook post bigbox api will automatically delete collections that have not been run for 2 months if you start multiple collections they are queued and processed sequentially to control the order of processing you can assign each collection a priority higher priority collections are started before lower priority ones learn more about priorities https //docs trajectdata com/bigboxapi/collections api/priorities request a collection can contain up to 15,000 requests (100 when adding requests with include html=true ) a request is simply a collection of parameters relating to an individual request to the home depot product data api result set when collections complete (that is, when all of their requests have been evaluated) a result set is generated you can use the collections api to retrieve result sets and ingest them into your app bigbox api retains result sets for 14 days so you should download your result set data within this 14 day window bigbox api provides api's to retrieve result sets in json and csv formats next steps create collection https //docs trajectdata com/bigboxapi/collections api/collections/create adding requests to a collection https //docs trajectdata com/bigboxapi/collections api/requests/create list result sets https //docs trajectdata com/bigboxapi/collections api/results/list