Opinionetwork Survey Widget Integration Instructions

Introduction

Precisionsample brings efficiency and automation to online sampling with precision Marketplace, the world’s most powerful, open, and customizable online sampling platform. The Demand and Supply APIs provide a simple way to connect to millions of people and get answers in real time. By specifying a set of demographic qualifications and quotas, buyers can target a wide or very specific population on a topic of your choosing. As a supplier, you get fine grain control over your survey matching and business relationships on the platform. We want to encourage innovation with minimal limits. We ask that you please be practical and considerate when determining call frequencies. We rate limit when needed to protect the system and ensure the highest level of service to all of our clients.

Iframe Setup

https://www.opinionetwork.com/reg/signup

Sample URL with Parameters: :

RID: It is provided by the Precision Sample, please reach to the support incase if you haven’t got yours.
Extmid: It should be the same value of what you have passed for the member while creating him using CREATE API. This should be unique for each member.

http://www.opinionetwork.com/reg/signup?rid=123456&extmid=testing

Sample Code to invoke the URL for Iframe Integration:

https://www.opinionetwork.com/reg/signup?rid=123456&extmid=testing

Member Uniqueness Rules:

• Is applied on rid & extmid values
• The first time we insert and any subsequent times, we only need these two passed in order to get into the surveys page.

Here are the privacy and terms of use policies.
https://www.opinionetwork.com/WidgetPrivacy.html
https://www.opinionetwork.com/WidgetTerms.html

Collect Pll Data

If all the PII information is not passed, we intercept and collect the PII information. At this time, the PII information is required, without which the member is not allowed to further proceed.

Here are the privacy and terms of use policies.

Member Dashboard (Surveys, Profiles )

Once the member is passed through the registration steps, they are dropped into the dashboard - that allows them to take surveys.Collect reward amounts and finally redeem them as well.

Create(Member Registration)

The purpose of this method is to insert a Lead into the White Label Panel using the API

Method URL (POST)

https://api4.opinionetwork.com/api/Member/Create

Method Headers

Key will be provided to each partner, use this key while calling Precision Sample API in Header with name AppKey

Method Input's

Input parameter	Description	Data Type	Required	Values
Rid	White Label Partner Id	integer	Yes	Accepts only integer values. << contact support for the partner ID>>
TxId	Transactional Id to be returned on post backs	Varchar(50)	No	Can be any values. Ex: 12343 or YD12e3w
ExtMemberId	Member Identifier on the partner site	Varchar (50)	Yes	Can be any values. Ex: 11213213 or AD1214
Country	Country of the member	Varchar(250)	No	Can be any values. Ex: USA or CA. . For other available Country Codes to pass please refer to end of the document Appendix A.
State	State of the member	Varchar(50)	No	Can be any values. Ex: Texas or TX
First Name	First name of the member	Varchar(250)	No	Can be any values. Ex: Donald or Donald II
Last Name	Last name of the member	Varchar(250)	No	Can be any values. Ex: Smith or Smith Jr
Email Address	Email Address of the member	Varchar(250)	No	Can be any values, but a valid email address regular expression is applied
Zip	Zip code of the member	Varchar(10)	No	Can be any values like 80255
Gender	Gender of the member	Char(1)	No	Accepts either M (for male) or F (for female)
DOB	Date of birth of member	varchar(20) ex: 04/14/1975	No	Values should be in the MM/DD/YYYY format
Address1	Address 1 of member	varchar(500)	No	Any string values up to 500 char length
Address2	Address 2 of member	varchar(500)	No	Any string values up to 500 char length
Ethnicity	Ethnicity of the member	Integer	No	Accepted Values: 1 white 2 Black or African American 3 Hispanic 4 American Indian or Alaskan Native 5 Asian Indian 6 Chinese 7 Filipino 8 Japanese 9 Korean 10 Vietnamese 11 pacific islander 12 Middle Eastern 13 Other Asian 14 Other 15 Prefer not to answer
City	City of the member	Varchar(50)	No	Can be any values. Ex: Texas or TX

Method Output(s)

The output is a string returned either with the following string values:
• Success (or)
• Failure

If the member is successfully inserted into the database, a unique identifier for the lead called the “Member GUID” is returned along with the success or failure message. The Member GUID is a 36 Char Hex Code, which cannot be hacked – but for all practical purposes is treated as just like any other string of length 36 characters. Example values:

• 21cc77ea-796a-4027-bd83-859db4147955

Both these values are “,” (comma) separated.

Example returned values: (are not case sensitive)
• “Success, user_guid =21cc77ea-796a-4027-bd83-859db4147955”
• “Failure”

Redirects

When the member completes/terms/OQs the survey we need to redirect the member back to your pages. Idealy url is to be redirect the members back to their page when our surveys are placed so that they can select another survey to participate in it.

The Parameters are explained below.

redirect URL

Parameter	Values	Sample Value	Type	Required	Description
ug	%%user_guid%%	645D2A50-1D53-40B7-9DD5-8238AFAF8029	varchar(36)	Optional	UserGUID you get after creating member
sub_id3	%%sub_id3%%	645D2A50-1D53-40B7-9DD5-8238AFAF8029 or fvgjhdbcdckhvjbr78475rehfb	varchar(36)	Optional	External Member ID
sub_id	%%sub_id%%	VAQ1234 or 123456	varchar(36)	Optional	Click ID or Transaction ID
user_invitation_guid	%%user_invitation_guid%%	6454FA50-1D53-40B7-9DD5-8238AFAF8089	varchar(36)	Optional	User Unique survey participation ID
surveyid	%%project_id%%	314581	int	Yes	Id of the Survey, member completed
title	%%survey_name%%	Health Survey	varchar(250)	Yes	Name of the Survey, member completed
Status	%%status%%	S or T or Q	varchar(5)	Yes	S, means member completed the Survey Preliminarily. T, means member failed or terminated from the survey. Q, means member quota full for the survey preliminarily we fire a pixel with status Initially when the member completes the survey preliminarily we fire a Pixel with status = S and then after 2 to 3 weeks (means, when we have the Updated final completes list from the client side people), if this member is not in the final completed list we fire the pixel with Status = R. So always the status “S” indicates that member can get reward and the Status “R” cancels the rewards issued preliminarily (Status = S).
survey_complete_date	%%survey_complete_date%%	11/21/2022	varchar(50)	Optional	Survey Completed Date
es_id	%%entry_project_id%%	314567	int	Optional	Entry Id of the Survey, member participated
gross	%%gross%%	2.4	numeric or decimal	Yes	Partner Gross revenue Share amount in $
reward	%%reward%%	1.2	numeric or decimal	Yes	Reward amount for the member in $ or if any conversion exists it will be in the respective conversion(Coins, Points)
code	%%code%%	1,2,3,4	varchar(10)	Optional	Survey Status Name

Post back

In general we do fire pixels or call backs, when an Partner Member Completes the Survey Preliminarily, so Partners need to build the below Call back URL to get the Survey Status for a Member.

The Parameters are explained below.

postback URL

parameter	Sample Values	Type	Required	Description
sub_id	VAQ1234 or 123456	varchar(20)	Optional	External Id
reward	1.2	numeric or decimal	Yes	Reward amount for the member in $
status	S or T or Q	Varchar (5)	Yes	S.means member completed the Surver preliminarily. T,means member failed ot terminated from the Survey. Q,means, member quota full for the Survet. R,means,member completed the Survey Preliminary but finally rejected by the Client.Initially when the member completes the survey preliminarily we fire a Pixel with status S and then after 2 to 3 weeks (means,When we have the Updated final complets list from the client side people),if this member is not in the final completed list we fire the pixel with Status R.So always the status "S" indicates that member can get reward and the Status"R"cancels the rewards issued preliminarily(Status=S).
title	Health Survey	Varchar(250)	Yes	Name of the Surrvey,member completed
surveyid	9345	int	yes	id of the survey,member completed
es_id	1234	int	Optional	Entry id of the Survey,member participated
gross	2.4	numeric or decimal	yes	partner Gross revenue amount in $

Country List

Country Code	Country Name
AU	AUSTRALIA
CA	CANADA
UK	UNITED KINGDOM
US	UNITED STATES OF AMERICA
MX	MEXICO
CR	COSTA RICA
PA	PANAMA
AR	ARGENTINA
CO	COLOMBIA
VE	VENEZUELA, BOLIVARIAN REPUBLIC OF
PE	PERU
CL	CHILE
BR	BRAZIL
IE	IRELAND
ES	SPAIN
PT	PORTUGAL
DE	GERMANY
AT	AUSTRIA
CH	SWITZERLAND
FR	FRANCE
NL	NETHERLANDS
BE	BELGIUM
IT	ITALY
JP	JAPAN
KR	South Korea
CN	CHINA
TW	TAIWAN
IN	INDIA
NZ	NEW ZEALAND