Tasks

A Task is the core unit of work that WXET Account can create (eg: buy) in order to solicit Users (eg: respondents) to complete the Task. A Task can be targeted in multiples ways, and it can have as many Users finish it.

The most simple Task can be created with the following request:

curl -X POST --location "https://api.wxet.org/v2/task/" \
    -H "Authorization: <API-Token>"
    -H "Content-Type: application/json" \
    -d '{
          "project_uuid": "<Active-Project-UUID>",
          "name": "test-task-0001",
          "display_name": "Fun Task",
          "expected_duration": 666,
          "live_url": "https://enter.survey.com/?foo=bar&session={{session_id}}",
          "required_finish_count": 100,
          "pricing_config": {"cpi": 1000, "config_type": "simple"}
        }'

A live_url can contain a wide range of variables that become available in the URL that the Worker is sent into, more details available. If the following API call succeeds correctly, a response will be given that looks like:

{
  "uuid": "339ff76cab434bfd8e9676ed2819a15f",
  "kind": 1,
  "name": "test-task-0001",
  "display_name": "Fun Task",
  "live_url": "https://enter.survey.com/?foo=4b2567&s={{session_uuid}}",
  "test_url": null,
  "live": false,
  "closed": false,
  "final": false,
  "archived": false,
  "version": 1,
  "finish_count_config": "comp",
  "required_finish_count": 100,
  "on_finish": null,
  "supply_config": null,
  "pricing_config": {"config_type": "simple", "cpi": 1000},
  "created": "2024-10-01T04:32:23.269327Z",
  "modified": null,
  "project": {
    "uuid": "366d27c2b56a4a4f81d4cc45d4aa9cea",
    "name": "test-9de505",
    "ext_metadata": {},
    "created": "2024-10-01T04:32:20.428397Z",
    "modified": null,
  }
}

However, at this point, the Task does not have any demographic targeting or fielding controls applied to it. More on those at in the follow sections.

Task

Last modified: 01 October 2024