List Result Sets

3min
List Result Sets
You can List all of the Result Sets for a Collection by making a  HTTP GET request to the  /Collections/COLLECTION_ID/results endpoint (where  COLLECTION_ID is the  id of the Collection to get Result Sets for). BigBox API retains Result Sets for 14 days so you should download your Result Set data within this 14 day window.
﻿
Example
﻿GET  /collections/COLLECTION_ID/results
In the example below we List all of the Result Sets for the Collection with  id=123456 :
HTTP
Curl
Node.js
Python
PHP
https://api.bigboxapi.com/collections/123456/results?api_key=demo
https://api.bigboxapi.com/collections/123456/results?api_key=demo
﻿
BigBox API responds with the following JSON showing all the Results Sets for the Collection. Note the  results array contains a list of all of the Result Sets. The  id property of a Result Set should be used with the Get Result Set endpoint to retrieve the actual results within the Result Set.
Note  the  results  array is sorted by the most recently run Result Set first.
JSON
{
  "request_info": {
    "success": true
  },
  "collection_id": "123456",
  "collection": {
    "id": "123456",
    "created_at": "2019-01-01T00:00:00.000Z",
    "name": "My First Collection",
    "schedule_type": "daily",
    "enabled": true,
    "status": "idle",
    "requests_total_count": 1,
    "requests_page_count": 1,
    "results_count": 1,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "[email protected]",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  },
  "results_count": 1,
  "results": [
    {
      "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,
      "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",
  "collection": {
    "id": "123456",
    "created_at": "2019-01-01T00:00:00.000Z",
    "name": "My First Collection",
    "schedule_type": "daily",
    "enabled": true,
    "status": "idle",
    "requests_total_count": 1,
    "requests_page_count": 1,
    "results_count": 1,
    "schedule_hours": [
      9,
      17
    ],
    "notification_email": "john.smith@example.com",
    "notification_as_json": false,
    "notification_as_jsonlines": false,
    "notification_as_csv": true
  },
  "results_count": 1,
  "results": [
    {
      "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,
      "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?
Find Requests
Get Result Set