Requesting Exports with API
Product Guides for EchoSpan 360-Degree Feedback
This API feature allows you to retrieve data exports from your projects using the EchoSpan REST web service. You can make API calls to EchoSpan using an HTTP GET request. When properly formed, your export data will be returned in comma-delimited format.
In order to use the API, you will need a current Professional Plus edition account as well as valid values for all required parameters.
Note that requests are processed in real-time, so larger data exports may require extended periods of time to download. In order to ensure high availability of system resources to all customers, larger exports may be limited during periods of peak activity. Your account may also have limits on the number of exports that can be retrieved per day. Please check with your client manager about these or other limitations.
To configure an API export request, direct your HTTPS GET request to the following URL:
| https://www.echospan.com/stream_rest.asp |
Export Request Parameters
| Parameter | Description/Possible Values | Required |
| Key | Unique 36 character string provided by your client manager used to validate your account's API privileges. This value can be passed either as a query string parameter named "key" or as an HTTP header named "Authorization". Example: 7AEA2F04-2725-4B7B-9623-1A698EZF24A8 | Yes |
| ClientID | A four-digit number provided by EchoSpan used to identify your account. | Yes |
| ExportID | Numeric value specifying the export you want to retrieve. This number is provided by your client manager. | Yes |
| SurveyIdent | The serial number of the survey project for which an export should be generated. This value is provided by EchoSpan for export requests that require it. | No |
| TargetID | The serial number of the Target for which an export should be generated. This value is provided by EchoSpan for export requests that require it. | No |
| Include Comments | Boolean value (1/0) specifying if the export should return comment responses. Default is to provide rated or numeric values only. | No |
| Recordset | Numeric value specifying which recordset you want to return. Some exports return more than one table of data. You can use this parameter to tell the API which table you want to retrieve. Default value is 1. | No |
| Delim | Field delimeter character separating data fields. Max length is 1 character. Default value is pipe character (|). | No |
| QuoteFields | When set to 1, all output fields will be encapsulated in quotation marks ("). By default, only fields that contain the delimiter character will be surrounded in quotation marks. | No |
| MaxRecords | Numeric value specifying the number of rows to return. Default is all records. | No |
Important Export Status Codes
| Status Code | Description |
| 200 | Data request successful. |
| 402 | Account is expired or payment is required. |
| 403 | Login invalid. |
| 404 | Export data not found. |
| 452 | Daily limit on downloads reached. |
| 453 | Database server too busy to process request. |
| 454 | Waiting for another call from your account to complete. Retry the request in a few minutes. |
| 455 | Recordset is empty. No data returned. |
362