RFG Offerwall API

Must be "offerwall/query/1"

A string uniquely identifying the respondent. The same string must be sent on repeat visits, allowing us to target using previously collected data.

The 2 character ISO country code

Australia, South Africa: 4 digits
US, France, Germany, Italy, Mexico, Saudi Arabia, Spain: 5 digits
South Korea, : 6 digits
Brazil: 8 digits
Canada: AnAnAn
Argentina: AnnnnAAA
UK: AAnAnAA, AnAnAA, AnnAA, AnnnAA, AAnnAA, AAnnnA
Other: anything

Accepted values:

• 1, m or M for male
• 2, f or F for female

The respondent's birthday, formatted as yyyy-MM-dd

String value corresponding to the respondent's IP. If included, we will use it to consider only the surveys where a respondent with the same IP has not participated, thus reducing the probability of a term due to deduplication.

The code to compute the fingerprint is available at https://hosting.researchforgood.com/js/df-fp.js
The fingerprint is computed using the following JavaScript:

function processDataForceFingerprint(fingerprint) {
        console.log("Please implement me!, fingerprint = " + fingerprint);
    }
    getDataForceFingerprint(processDataForceFingerprint);

If you are not able to generate the fingerprint, you can send fingerprint:0. In such cases, the rid value becomes mandatory. We will use the fingerprint value we have stored in our system for that respondent in order to determine if the respondent is likely to be ruled out because of deduplication. If the respondent has not started a session with us yet, then we will only consider the IP value. Please note that this is not the preferred option: if you are able to run javascript and generate a fingerprint, you should send the fingerprint value to us. Only use this workaround if you cannot run javascript on your site / app.

Optional parameter that indicates the kind of projects that should be returned:

0. All
1. Surveys
2. Offers

Additional Datapoints

In addition to the above parameters, you may also send us any of the datapoints listed in the RFGdatapoints.json file.
That file contains a JSON document listing all of our basic profiling datapoints, including questions and answer translated into multiple languages. The structure of each datapoint is as follows:

{
    property: "propertyName",		 		//  This is the property to send us
    name: "Human readable name",			//  Ignore
    countries: ["US","CA"],				//  The countries this datapoint applies to
    type: 0, 						//  Indicates single or multi-valued
    question: {						//  The question in many languages
	en-US: "The question in US English",
	es-US: "The question in US Spanish",
	etc...
    }
    answers: [						//  The answers in many languages
        null,						//  Answer #0 is always null
        {						//  The first answer starts with 1
            en-US: "Answer #1 in US English",		//  Answers are provided in many languages
            es-US: "Answer #1 in US Spanish",
            etc...
        },
        {
            en-US: "Answer #2 in US English",
            es-US: "Answer #2 in US Spanish",
            etc...
        },
        {
            en-US: "Answer #3 in US English",
            es-US: "Answer #3 in US Spanish",
            etc...
        },
        etc...
    ]
}

Datapoint Types

Datapoint types may be:

0. Radio Buttons (single selection). Please send us the property name followed by a single integer indicating the selected answer. E.g. householdIncome: 4
1. Checkboxes (multiple selection). Please send us the property name followed by an array of integers indicating the selected answers. E.g. ethnicityUS: [1,2,4]
2. Dropdown (single selection). Please send us the property name followed by a single integer indicating the selected answer. E.g. employmentIndustry: 2

For these optional datapoints, you may provide as few or as many as you wish. Any datapoints not provided will be profiled when the respondent begins to take surveys. Please note that some datapoints only apply to certain countries. If a datapoint does not list countries, then it applies to all countries.