Skip to main content

Survey entry link

Survey entry link is generated on RapidoReach side and returned as part of fetch top surveys for user API endpoint response.

Used to load the survey for the particular user Returned link has hash signature applied and is supposed to be used without modification Optionally, the link can be extended by partner by appending sub_id query parameter Although the partner does not need to be fully aware of how entry link is constructed, the link template and correspondent parameters are given below for full transparency.

Template​

https://www.rapidoreach.com/ofw/api/?api_respondent_id={RapidoreachUserId}&cpi={CPI}&loi={LOI}&surveynumber={SurveyNumber}&providedby={ProvidedBy}&i=63f1f51e59c927d429b1730b&enc=9d1ea09722600c0395d70ba621a9c3cbb3d9b18b

Parameters​

ParameterSourceDescriptionRequired
SurveyNumberqueryId of the surveytrue
Rapidoreach UIDqueryClick here to know more about rapidoreach UIDtrue
ProvidedByqueryClient of the surveytrue
User IDqueryUser id for rapidoreach usetrue
encqueryrapidoreach internal security parametertrue

Parameter that can be used for partner specific data

  • The value of this parameter is returned back to the partner in redirect links and S2S callbacks
  • Accepts only alphanumeric characters + underscore and dash false hash query Hash signature to prevent unauthorized use and link manipulation by third parties true

Example​

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

Entry link signature​

As stated above, the survey entry links returned in the response of Fetch top surveys for user API endpoint already have a hash signature applied for ease of use. That hash signature on the link is applied on the RapidoReach side following the Link signing process.

Entry link modification​

The partner has the ability to modify the returned survey entry link to pass extra parameters like sub_id to RapidoReach. Optional alias identifier to track traffic on campaigns, can be used for testing and segmentation purposes. Please ask our team to enable sub_id for you.

Append extra parameters to the unsigned link Apply hash signature on the modified link following the Link signing process

INFO

The sub_id parameter is the only extra parameter supported currently, but please note that in future versions RapidoReach may introduce additional parameters.