/filter-outputs/{filter_output_id}/preview

GET

Get a preview of up to 100 observations using the state of the filter output job. By default only 20 rows will be returned. To change this use the `limit` query. It could be possible no results are returned due to data sparsity.

Responses

200: A preview of the current filter state has been returned

Example value
{
  "description": "A preview of the current filter state",
  "type": "object",
  "properties": {
    "headers": {
      "description": "A list of all headers in the dataset",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "number_of_columns": {
      "description": "The number of columns",
      "type": "integer"
    },
    "number_of_rows": {
      "description": "The number of rows, this can be in the range of 0 - 20",
      "type": "integer"
    },
    "rows": {
      "description": "A list of all rows for the preview as a two dimensional array",
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "readOnly": true
}

400: No dimensions are present in the filter output

Example value
null

404: The filter id was not found

Example value
null

500: Failed to process the request due to an internal error

Example value
null