Get Schema Response

The JSON Schema describing the values field a survey response of the format returned by JSON Response Exports and by the Retrieve a Survey Response endpoint.

result objectrequired

$schema$schema (string)required

Possible values: [https://json-schema.org/draft/2019-09/schema]

$idstring<uri>required

titletitle (string)required

descriptiondescription (string)required

typetype (string)required

Possible values: [object]

requiredstring[]required

properties objectrequired

displayedFields object

descriptiondescription (string)

typetype (string)

Possible values: [array]

items object

typetype (string)

Possible values: [string]

displayedValues object

descriptiondescription (string)

typetype (string)

Possible values: [object]

additionalProperties object

typetype (string)

Possible values: [array]

labels object

descriptiondescription (string)

typetype (string)

Possible values: [object]

additionalPropertiesadditionalProperties (boolean)

Possible values: [true]

responseId object

typetype (string)

Possible values: [string]

values object

typetype (string)

Possible values: [object]

descriptiondescription (string)

properties object

distributionChannel object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

duration object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

endDate object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

finished object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

locationLatitude object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

locationLongitude object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

progress object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

recordedDate object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

startDate object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

status object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

userLanguage object

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

property name* SchemaProperty

Each entry represents a field in the values field of the JSON survey response

typetype (string)required

Possible values: [array, integer, number, object, string]

descriptiondescription (string)required

formatformat (string)

Possible values: [date-time]

questionIdquestionId (string)

The ID of the question this field is associated with

loopNumberloopNumber (integer)

For loop and merge questions, this field documents which loop number the field in the JSON instance represents

exportTagexportTag (string)

The export tag of this field

questionExportTagquestionExportTag (string)

The export tag of the question this field is associated with

dataTypedataType (string)

The type of data this field represents

Possible values: [metadata, question, embeddedData]

oneOf object[]

Array [

labellabel (string)

property name*any

]

items object

typetype (string)

oneOf object[]

Array [

labellabel (string)

property name*any

]

properties object

x object

typestring

Possible values: [number]

y object

typestring

Possible values: [number]

requiredstring[]

A list of fields that will always be on the survey response. This list is the same across all surveys.

meta objectrequired

httpStatushttpStatus (string)required

HTTP status code

requestIdrequestId (string)required

An identifier for the incoming request.

noticeAn informational string about the request. (string)

Get Schema Response

{
  "result": {
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "$id": "string",
    "title": "string",
    "description": "string",
    "type": "object",
    "required": [
      "string"
    ],
    "properties": {
      "displayedFields": {
        "description": "string",
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "displayedValues": {
        "description": "string",
        "type": "object",
        "additionalProperties": {
          "type": "array"
        }
      },
      "labels": {
        "description": "string",
        "type": "object",
        "additionalProperties": true
      },
      "responseId": {
        "type": "string"
      },
      "values": {
        "type": "object",
        "description": "string",
        "properties": {
          "distributionChannel": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "duration": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "endDate": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "finished": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "locationLatitude": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "locationLongitude": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "progress": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "recordedDate": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "startDate": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "status": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          },
          "userLanguage": {
            "type": "array",
            "description": "string",
            "format": "date-time",
            "questionId": "string",
            "loopNumber": 0,
            "exportTag": "string",
            "questionExportTag": "string",
            "dataType": "metadata",
            "oneOf": [
              {
                "label": "string"
              }
            ],
            "items": {
              "type": "string",
              "oneOf": [
                {
                  "label": "string"
                }
              ],
              "properties": {
                "x": {
                  "type": "number"
                },
                "y": {
                  "type": "number"
                }
              }
            }
          }
        },
        "required": [
          "string"
        ]
      }
    }
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}