Get Surveys

Market Research API Parameters

API parameters pubID, profileID, and api_key can be found on the Integration page. The link is located next to your profile at Your Market Research Profiles.

If you would like us to notify you whenever an offer is completed (lead generated), set up a server postback.

Get Surveys

Retrieves a list of all surveys available for a user profile. You must create a Survey User Profile before you will get a valid response from this API call.

Response 204 when no surveys are available for the given parameters.

Response 400 when required parameter not provided.

Response 404 when profileId doesn't exist for the specified pubId.

GET:

http://adscendmedia.com/market-research/api/publisher/{pubId}/profile/{profileId}/user/{subid1}/surveys.json?subid2={subid2}&subid3={subid3}&subid4={subid4}&limit={limit}&offset={offset}

Parameters   Description Type
pubId Required Your publisher ID Number
profileId Required Your Market Research profile ID Number
subid1 Required Your user's primary unique identifier. Maximum length of 60. String
subid2 Optional Used for click and lead tracking. Maximum length of 60. String
subid3 Optional Used for click and lead tracking. Maximum length of 60. String
subid4 Optional Used for click and lead tracking. Maximum length of 60. String
limit Optional Used for pagination. All are shown by default. Example: 10 Number
offset Optional Used for pagination. Example: 40 Default: 0 Number

Response 200

Content-Type: application/json

{
  "surveys": [
    {
      "name": "High Paying Survey", //Not all surveys have a unique name, the default value is 'High Paying Survey'
      "click_url": "click_url_here",
      "payout": 11.2,
      "currency_count": 5600,  // calculated currency based on the exchange_rate found in the Get Profile Details API call.
    }
]}