API Endpoint

Definition

This API endpoint allows you to fetch the top RapidoReach surveys for a given user in real time.

Request

POST https://www.rapidoreach.com/getallsurveys-api

Headers

Header	Description	Required
X-RapidoReach-Api-Key	Authentication API Key (App key can be found from app credentials page)	true

Parameters

Endpoint accepts a range of parameters provided in body of on the request.

Root parameters

Parameter	Description	Required
UserId	Unique user identifier	true
AppId	App Id of placement defined in Publisher dashboard	true
IpAddress	IP address of the user	true
City	City of the user	true
CountryLanguageCode	CountryLanguageCode of the user eg: ENG-US, ENG-IN etc See list of supported languages.	true
DateOfBirth	User's date of birth	false
Gender	User's gender (M for male and F for Female)	false
ZipCode	User's correct and validated zipcode	false

Examples

cURL

curl --location --request POST 'https://www.rapidoreach.com/getallsurveys-api/' \
--header 'X-RapidoReach-Api-Key: a70f2d8c5a69b7d359fafdf7b4a09g56' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserId": "someUserIdofYourApp",
    "AppId": "X2Qz4ddj1",
    "IpAddress": "106.213.81.42",
    "City": "New york",
    "CountryLanguageCode": "ENG-US",
    "DateOfBirth": "1993-01-21",
    "Gender": "M",
    "ZipCode": "11111"
}'

Success model

Successful response is a JSON array of survey objects with the properties given below.

Property	Type	Description	Required
SurveyNumber	string	Id of the survey	true
SurveyUrl	string	Survey entry link for the user. See Survey entry link section for more details.	true
Reward	decimal	Reward in partner defined currency	true
LOI	decimal	Length of interview (minutes)	true
MatchingPercentage	integer	Conversion rate (%)	true
vc_name	integer	partner defined currency	true

Error model

Error response is a JSON object with the properties given below.

Property	Type	Description	Required
Errors	array	API errors in array it includes a list of all possible error messages	false
Info	array	any other info description	false
Data	array of objects	Error messages providing further error details	false
ErrorCode	string	Error code	true

Examples

Success (200) Bad Request (400) Internal Server Error (500)

[
    {
            "ProvidedBy": "Google",
            "Reward": 59,
            "SurveyNumber": "37146073",
            "vc_name": "CB1234",
            "CPI": 1.18,
            "LOI": 10,
            "Link": "/surveylink/create/YOURSURVEYS/37146073?i=63f1f51e59c927d429b1730b&enc=9d1ea09722600c0395d70ba621a9c3cbb3d9b18b",
            "Survey": {
                "BidLengthOfInterview": 10,
                "SurveyName": "Other study"
            },
            "MatchingPercentage": 100,
            "SurveyUrl": "https://www.rapidoreach.com/ofw/api/?api_respondent_id=testapi001-X2Qz5dxNX-763fab1b7c822cd9d69bc870a0bc831b&cpi=1.18&loi=10&surveynumber=37146073&providedby=YOURSURVEYS&i=63f1f51e59c927d429b1730b&enc=9d1ea09722600c0395d70ba621a9c3cbb3d9b18b"
        },
        {
            "ProvidedBy": "Apple",
            "Reward": 94,
            "SurveyNumber": "37146770",
            "vc_name": "CB1234",
            "CPI": 1.88,
            "LOI": 20,
            "Link": "/surveylink/create/YOURSURVEYS/37146770?i=63f1f51e59c927d429b1730b&enc=fefb47ac5b6e4ff07411888282cd318e4e2d0596",
            "Survey": {
                "BidLengthOfInterview": 20,
                "SurveyName": "Let us know what you think"
            },
            "MatchingPercentage": 100,
            "SurveyUrl": "https://www.rapidoreach.com/ofw/api/?api_respondent_id=testapi001-X2Qz5dxNX-763fab1b7c822cd9d69bc870a0bc831b&cpi=1.88&loi=20&surveynumber=37146770&providedby=YOURSURVEYS&i=63f1f51e59c927d429b1730b&enc=fefb47ac5b6e4ff07411888282cd318e4e2d0596"
        },
    // ...
]

Pass User Profile Data

Profiler data parameters represent user answers for given questions used as survey qualifications. You do not have to pass these, as we will collect this data as needed. If you would like to initially pass data for a user, please see the full list of profiler data parameters to get all supported parameters and their value options per language.

INFO

All profiler data parameters other than the ones listed as required above are optional and can be omitted in the request.