Start Collection

start collection collections can be started by making an http get request to the /collections/collection id/start endpoint (where collection id is the id of the collection) you must have sufficient request credits available on your account for the number of requests in the collection you would typically start collections that are set to schedule type=manual but you can start a collection with any schedule type , just as long as it isn't currently running example get get /collections/collection id/start in the example below we start a collection with id=123456 http https //api bigboxapi com/collections/123456/start?api key=demo$ curl "https //api bigboxapi com/collections/123456/start?api key=demo"const axios = require('axios'); const params = { api key 'demo' } axios get('https //api bigboxapi com/collections/123456/start', { params }) then(response => { const apiresponse = response data; console log('collection started '); }) catch(error => { console log(error); });import requests params = { 'api key' 'demo' } api result = requests get('https //api bigboxapi com/collections/123456/start', params) api response = api result json() print "collection started "\<?php $querystring = http build query(\[ 'api key' => 'demo', ]); $ch = curl init(sprintf('%s?%s', 'https //api bigboxapi com/collections/123456/start', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $json = curl exec($ch); curl close($ch); $api result = json decode($json, true); print r($api result); echo "collection started ", php eol; ?> bigbox api responds with a json object confirming that the collection has been started, or detailing the error if it has not been possible to start the collection (i e there are insufficient request credits available on your account) next steps get collections https //docs trajectdata com/bigboxapi/collections api/collections/get list collections https //docs trajectdata com/bigboxapi/collections api/collections/list