Lucid

In order to easily support legacy of API Programmatic Buyers, WXET has full support of Lucid's question_id and pre_codes Qualification and Quota syntax through WXET's Connector system.

WXET's platform and it's Supplier Network platform ensure that only respondents that match the eligible Connector's targeting criteria are made eligible to enter the Task.

Qualifications

A Task can have up to 25 Qualifications. Each Qualification must be POST'd to the Task individually.

Qualifications act as filters to selectively allow users into the Task that have provided WXET's Supplier Network the associated Profiling Question Answers that allow them to enter the Task.

A Task cannot have a Qualification with identical targeting criteria of another Qualification on the Task. Additionally, if a "random" question_id is provided, or the provided pre_codes do not align with Profiling Question in the Lucid library, the Qualification creation will fail with a HTTP_422_UNPROCESSABLE_ENTITY validation error.

curl -X POST --location "https://api.wxet.org/v2/task/<task-uuid>/connector/lucid/qualification/" \
 -H "Authorization: <API-Token>"
 -H "Content-Type: application/json"
 -d '{
   "question_id": 96,
   "pre_codes": ["1"],
 }'

An existing Qualification can also be updated.

Even when a Task is live, Qualifications can be edited. Qualification deletion will be coming soon.

Quotas

A Task can have up to 25 Quotas. Each Quota must be POST'd to the Task individually. Each Quota may have up to 25 criteria. An upper_limit must be provided for a Quota. An upper_limit of 0 will fail as it essentially implies that this Quota should never be targeted for, so there is no purpose on having the Quota defined.

If the upper_limit is greater than the total number of finishes for a Task, it will essentially never be enforced.

A Task cannot have a Quota with identical targeting criteria of another Quota on the Task. Additionally, if a "random" question_id is provided, or the provided pre_codes do not align with Profiling Question in the Lucid library, the Quota creation will fail with a HTTP_422_UNPROCESSABLE_ENTITY validation error.

When a user enters the Task, WXET will assign the Wall Event with the associated Quota that the user entered.

curl -X POST --location "https://api.wxet.org/v2/task/<task-uuid>/connector/lucid/quota/" \
 -H "Authorization: <API-Token>"
 -H "Content-Type: application/json"
 -d '{
  "upper_limit": 150,
  "criteria": [
    {
     "question_id": 96,
     "pre_codes": ["1"],
    }, {
     "question_id": 633,
     "pre_codes": ["1", "2", "3"],
    },
   ]
  }'

An existing Quota can also be updated before a Task goes live. Once a Task goes live, a Quota cannot be deleted. This is because a Worker's entrance has been permanently associated with a specific Quota allocation.

Last modified: 01 October 2024