You may use this endpoint to retrieve all surveys in your account.
Request
...
GET $apihost/$basepath/surveys
($apihost is the environment against which you are testing, All Buy API calls will require access_token parameter in the header)
...
Response Parameter | Type | Description | Example |
|---|---|---|---|
status | integer - enum: 22: return live surveys (default) 11: return draft surveys 33: return paused surveys 44: return closed surveys | You may select the status to be returned by this API endpoint | status=22 |
fromDate | integer - format=YYYYMMDD | Returns only surveys created on or after the value in fromDate. These dates are in Pacific Time. | fromDate=20190101 |
toDate | integer - format=YYYYMMDD | Returns only surveys created on or before the value in fromDate. These dates are in Pacific Time. | toDate=20191231 |
targeting | integer - enum: 1: returns the normal survey response with qualification and quota arrays. (default) 0: suppresses the qualifications and quotas array to reduce response size | Using targeting=0 will suppress the response of the qualifications and quotas array | targeting=0 |
limit | integer - enum: | Returns only the number of surveys specified. | limit=20 |
Sample Request:
...
| Code Block | ||
|---|---|---|
| ||
GET api.spectrumsurveys.com/buyers/v2/surveys?status=11&fromDate=20190101&toDate=20190131&targeting=0 |
...