Datafiniti · Schema

SearchRequest

Business DataData AggregationData as a ServicePeople DataProduct DataProperty Data

Properties

Name Type Description
query string Datafiniti query expression filtering records.
num_records integer Maximum number of records returned in a download.
download boolean When true, request a bulk download of all matching records.
format string Bulk download format such as JSON or CSV.
view string Named view selecting a subset of fields.
View JSON Schema on GitHub

JSON Schema

datafiniti-searchrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchRequest",
  "title": "SearchRequest",
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "Datafiniti query expression filtering records."
    },
    "num_records": {
      "type": "integer",
      "description": "Maximum number of records returned in a download.",
      "minimum": 1
    },
    "download": {
      "type": "boolean",
      "description": "When true, request a bulk download of all matching records."
    },
    "format": {
      "type": "string",
      "description": "Bulk download format such as JSON or CSV.",
      "enum": [
        "JSON",
        "CSV"
      ]
    },
    "view": {
      "type": "string",
      "description": "Named view selecting a subset of fields."
    }
  }
}