Survey_Find(string key)

Description

Find surveys based on specific criteria

Parameter Type Required Description
key string Yes
Your API key – used to authenticate your account
optionalParameters[surveyId] int No
Return only the survey with the supplied ID
optionalParameters[status] word No
Return only surveys matching this status. Must be one of “draft”, “active”, or “complete”.
optionalParameters[type] word No
Return only surveys matching this type. Must be one of “survey” or “event”.
optionalParameters[startDate] date No
Return only surveys started on this date (UTC)
optionalParameters[endDate] date No
Return only surveys ending on this date (UTC)
optionalParameters[page] int No
Return surveys on this page of the search results
optionalParameters[offset] int No
Starting index to return results from. Indexed from 0.
optionalParameters[num] int No
Number of results to return
Call (GET)
http://api.surveytown.com/2/REST/?method=Survey_Find&key=YOUR_API_KEY&optionalParameters[surveyId]=1
Response