API documentation
Account
Basic Campaigns
- GET
- /campaign_b/get_task_info/
- /campaign_b/list_tasks/
- /campaigns_b/list
- /campaigns_b/list_extend
- /campaign_b/list_tasks_extend/
- /campaign_b/get_status/
- /campaign_b/get_info/
- /campaign_b/download_file_proof/
- /campaign_b/zones_list/
- /campaign_b/categories_list/
- /campaign_b/get_worker_tasks/
- /campaign_b/results_csv/
- POST, PUT
- /campaign_b/set_speed/
- /campaign_b/new_campaign
- /campaign_b/stop/
- /campaign_b/pause/
- /campaign_b/resume/
- /campaign_b/rate_task/
- /campaign_b/rate_tasks/
- /campaign_b/add_positions/
- /campaign_b/submit_proof/
- /campaign_b/submit_file_proof/
- /campaign_b/retarget/
- /campaign_b/restart_campaign/
- /campaign_b/toggle_qt_required/
HG Campaigns
- GET
- /campaign_hg/get_task_info/
- /campaign_hg/list_tasks/
- /campaign_hg/list_tasks_extend/
- /campaigns_hg/list
- /campaigns_hg/list_extend
- /campaign_hg/get_status/
- /campaign_hg/get_info/
- /campaign_hg/categories_list/
- /campaign_hg/groups_list/
- /campaign_hg/download_file_proof/
- /campaign_hg/get_worker_tasks/
- /campaign_hg/results_csv/
- POST, PUT
- /campaign_hg/new_campaign
- /campaign_hg/stop/
- /campaign_hg/pause/
- /campaign_hg/resume/
- /campaign_hg/rate_task/
- /campaign_hg/rate_tasks/
- /campaign_hg/add_positions/
- /campaign_hg/submit_proof/
- /campaign_hg/submit_file_proof/
- /campaign_hg/lock_task/
- /campaign_hg/change_group/
- /campaign_hg/restart_campaign/
- /campaign_hg/toggle_qt_required/
Employer
- GET
- /employer/exclude_list
- POST
- /employer/exclude_list
- DELETE
- /employer/exclude_list
Worker
Messages
/campaign_hg/new_campaign POST
Starts a new campaign.
Parameters:
Title
Group ID
Category ID
How many minutes will this job take
The total number of positions (tasks) available to all participants in the campaign. available_position must be a positive integer
Maximum number of positions (tasks) each worker can participate in
Cost per task (example: 0.10, 0.13, 0.56,...)
[SAME|UNIQUE]. If description type is SAME - all users will see same description. If it is UNIQUE, each user will have different description, with this UNIQUE option "csv" parameter is required
Description of what is required
Users will submit required proofs after completing the task. HG campaigns support up to 3 proofs per position (task). For one required proof, please use -F "required_proof=<required_proof>", For more than one required proof, please use -F "required_proof[]=<required_proof_1>" -F "required_proof[]=<required_proof_2>"
Time to rate in days (1-30)
[NO|V|V+R]
[0|1|2] Where:
0 - Workers do not have to upload any files as proof
1 - Workers can optionally upload files as proof
2 - Workers are required to upload files as proof
(Optional) File as part of the Campaign
CSV file with template variables. Required for description_type = UNIQUE only, otherwise - not used
(Optional) [0|1] Where:
0 - No
1 - Yes (Default)
Return values:
status=SUCCESS, campaign_id=[campaign id], speed_previous=[x], speed_new=[y]
status=ERROR, errors=[array of error messages*], min_payment_per_task=[min payment per task]
Code:
cURL:
PHP:
Perl:
Python:
C#:
Examples:
Output (Success):
{
"status": "SUCCESS",
"campaign_id": "86f343b74104",
"cost": "3.975"
}
Output (Error):
{
"status": "ERROR",
"campaign_id": "86f343b74104",
"errors": [
"POSITIONS",
"AUTO RATE",
"min_payment_per_task": 0.05
]
}