Pagination Object

A wrapper around a list of objects so they can be paginated over many requests. If an API endpoint might return a long list of values, it will return those values in a paginated form. The paginated data will have either a before or after value, and that value should be provided on the next API request to get the remaining values. For more information on pagination, see the pagination overview.

Fields

KeyTypeValue
countintThe total number of values being paginated over.
dataarrayThe values on this page.
pagingobjectAn object containing a before value and/or an after value. One of these values should be provided on the next API request, depending on the direction you are paging.

Example

{
  "count": 3,
  "data": [
    {
      "assignments": {
        "degree": 2,
        "gamma": 3.6,
        "kernel": "rbf"
      },
      "created": 1560895206,
      "experiment": "1",
      "failed": false,
      "id": "1",
      "metadata": null,
      "object": "observation",
      "suggestion": "1",
      "value": 1,
      "value_stddev": null,
      "values": [
        {
          "name": "Accuracy",
          "object": "metric_evaluation",
          "value": 1,
          "value_stddev": null
        }
      ]
    },
    {
      "assignments": {
        "degree": 2,
        "gamma": 3.6,
        "kernel": "rbf"
      },
      "created": 1560895206,
      "experiment": "1",
      "failed": false,
      "id": "1",
      "metadata": {
        "estimated_training_time_s": 302
      },
      "object": "observation",
      "suggestion": "1",
      "value": 1,
      "value_stddev": 0.1,
      "values": [
        {
          "name": "Accuracy",
          "object": "metric_evaluation",
          "value": 1,
          "value_stddev": 0.1
        }
      ]
    },
    {
      "assignments": {
        "degree": 2,
        "gamma": 3.6,
        "kernel": "rbf"
      },
      "created": 1560895206,
      "experiment": "1",
      "failed": true,
      "id": "2",
      "metadata": null,
      "object": "observation",
      "suggestion": "2",
      "value": null,
      "value_stddev": null
    }
  ],
  "object": "pagination",
  "paging": {
    "after": "2",
    "before": null
  }
}