Collections
...
Collections API
Result Sets

Get Result Set

7min

Get Result Set

You can retrieve the results within a Result Set by making making an HTTP GET request to the /collections/COLLECTION_ID/results/RESULT_SET_ID endpoint (where COLLECTION_ID is the id of the Collection to retrieve results for, and RESULT_SET_ID is the id of the Result Set within that Collection).



Get Result Set as JSON

GET /collections/COLLECTION_ID/results/RESULT_SET_ID

In the example below we retrieve a Result Set with id=1 in Collection with id=123456 in JSON format:

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON showing the Result Set details and download_links for each page of JSON files containing the results:

JSON



Get Result Set as JSON Lines

GET /collections/COLLECTION_ID/results/RESULT_SET_ID/jsonlines

In the example below we retrieve a Result Set with id=1 in Collection with id=123456 in JSON Lines format:

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON showing the Result Set details and download_links for each page of JSON Lines files containing the results:

JSON



Get Result Set as CSV

GET /collections/COLLECTION_ID/results/RESULT_SET_ID/csv

We provide a further endpoint, /collections/COLLECTION_ID/results/RESULT_SET_ID/csv , to retrieve the Result Set in CSV format.

When using this endpoint you can supply a csv_fields querystring parameter to determine the fields that are included in the CSV file. the csv_fields parameter should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information see the CSV Fields Reference.

In the example below we retrieve a Result Set with id=1 in Collection with id=123456 in CSV format:

HTTP
Curl
Node.js
Python
PHP


Backyard API responds with the following JSON showing the Result Set details and download_links for each page of CSV files containing the results:

JSON