JSON request for retrieving submissions

Send the request body in JSON format to the Reporting API endpoint.

Request Body

{
  "token": "your-token-here",
  "exportFormat": 1,
  "dateStart": "2021-03-31",
  "dateStop": "2021-04-30"
}

Request Parameters

Export Formats

0 - Standard CSV
Exports multiple-value questions as a single row.

1 - Fixed-column CSV
Exports multiple-value questions as a single row with a static number of columns. This is typically useful where survey logic is being used and a consistent export structure is required.

2 - Multi-row CSV
Exports multiple-value questions across multiple rows.

API Responses

The Reporting API uses standard HTTP response codes to indicate the result of each request.

200 - Success

The request was successful and the CSV output will be returned.

400 - Incorrect Request

The request could not be processed.

Where a specific issue can be identified — such as an invalid exportFormat or incorrect date — an error message will be returned providing further information.

401 - Authentication Error

Authentication was unsuccessful.

This may occur where:

• No API token has been provided
• The API token is invalid
• The Reporting API User is inactive

403 - Access Denied

The API User does not have permission to access the requested report.

This may occur where:

• The report has not been assigned to the API User
• The Report ID is incorrect
• The report no longer exists