Ethnio API

There are currently two major components to the Ethnio API. The Access & Erasure endpoints are designed for Enterprise customers to send automated requests to Ethnio via API for common compliance tasks like Erasure, Opt Out, and Data Subject Requests. The Screener Data endpoint is designed to pass Responses from a single screener to 3rd Party Tools so that customers can track successful completes in Ethnio and pay incentives accordingly. 

Access & Erasure

Allows Enterprise customers to send automated Erasure, Opt Out, and Data Subject Requests via API. All the details for this are located here.

1. Erasure
2. Opt Out - note that if you send opt out emails to Ethnio that do not exist in your Pool, we will return a "non-existing" message and not store those emails.
3. Data Subject Requests

Screener Data 

Please note this API is being deprecated in 2021. The idea with passing screener data via API is that after a respondent fills out questions and submits a screener response, if they are clicking through to an external tool such as an automated testing site, Ethnio can pass along response data to the tool. Let's say the tool is "sample.com," the user will be presented with a link that directs them to this sample test URL:

sample.com/test/3632

The actual link Ethnio passes to the partner has the token appended to the URL, so that looks like this:

sample.com/test/3632?token=620504280621

Screener Data Methods 

These are the current methods for using our secure token. Please note we have to authorize each domain before any of these methods will work.

1.0 Completed

Notifies Ethnio that the participant has successfully finished their test at a third party tool.

Example:

For XML: (Defaults to XML when extension is omitted)
curl -X GET ethn.io/partners/completed.xml -d "token= 620504280621"

For JSON: 
curl -X GET ethn.io/partners/completed.json -d "token= 620504280621”

2.0 Response

Returns the response data model, sometimes referred to as “recruit.”

Example:

For XML: (Defaults to XML when extension is omitted)
curl -X GET ethn.io/partners/recruit.xml -d "token= 620504280621"

For JSON: 
curl -X GET ethn.io/partners/recruit.json -d "token= 620504280621”

Return Data

For the recruit model in JSON:

{"referer_url": "ethn.io", "recruit_status_id": 1, "name":"John Doe", "deleted_at": null, "incentive": "Earn $75 at Amazon.com", "screener_id": 2417, "id": 208796, "note": null, "ip": "127.0.0.1", "browser": "Mozilla/5.0", "email": “john@aol.com”, "created_at": "2010/04/01 18:02:48 +0000"} 

And the recruit model in XML:

<?xml version="1.0" encoding="UTF-8"?> <recruit>
<browser>Mozilla/5.0</browser>
<created-at type="datetime">2010-04-01T18:02:48Z</created-at> <deleted-at type="datetime" nil="true"></deleted-at>
<email nil="true">john@aol.com</email>
<id type="integer">208796</id>
<incentive>Earn $75 at Amazon.com</incentive> <ip>127.0.0.1</ip>
<name nil="true">John Doe</name>
<note nil="true"></note>
<recruit-status-id type="integer">1</recruit-status-id> <referer-url>ethn.io</referer-url>
<screener-id type="integer">2417</screener-id>
</recruit>