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
https://api.bigboxapi.com/collections/123456/results/1?api_key=demo
https://api.bigboxapi.com/collections/123456/results/1?api_key=demo
﻿
BigBox API responds with the following JSON showing the Result Set details and  download_links for each page of JSON files containing the results:
JSON
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.json"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages.zip"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.json"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages.zip"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
﻿
﻿
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
https://api.bigboxapi.com/collections/123456/results/1/jsonlines?api_key=demo
https://api.bigboxapi.com/collections/123456/results/1/jsonlines?api_key=demo
﻿
BigBox 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
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.jsonl"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages_jsonlines.zip"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.jsonl"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages_jsonlines.zip"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
﻿
﻿
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
https://api.bigboxapi.com/collections/123456/results/1/csv?api_key=demo
https://api.bigboxapi.com/collections/123456/results/1/csv?api_key=demo
﻿
BigBox API responds with the following JSON showing the Result Set details and  download_links for each page of CSV files containing the results:
JSON
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.csv"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages_246f6e2e561c90958384aa76e455e2bc95ad3a01.csv"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "result": {
    "id": 1,
    "started_at": "2019-01-02T00:00:00.000Z",
    "ended_at": "2019-01-02T00:00:10.000Z",
    "expires_at": "2019-01-08T00:00:10.000Z",
    "results_page_count": 1,
    "requests_completed": 1,
    "requests_failed": 0,
    "requests_total": 1,
    "download_links": {
      "pages": [
        "https://results.bigboxapi.com/Collection_Results_123456_1_Page_1.csv"
      ],
      "all_pages": "https://results.bigboxapi.com/Collection_Results_123456_1_All_Pages_246f6e2e561c90958384aa76e455e2bc95ad3a01.csv"
    },
    "webhook_status": {
      "status": "ok",
      "log": [
        {
          "date_time": "2020-01-01T00:00:00.000Z",
          "text": "Webhook POST completed successfully."
        }
      ]
    },
    "destination_status": {
      "DESTINATION_ID": {
        "status": "ok",
        "log": [
          {
            "date_time": "2020-01-01T00:00:00.000Z",
            "text": "Destination upload completed successfully."
          }
        ]
      }
    }
  }
}
﻿
﻿
Updated 07 Aug 2024
Did this page help you?
List Result Sets
Resend Webhook