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_b/new_campaign POST
Starts a new campaign.
Parameters:
Title
Zone you want to target [asia1|caribbean1|europe1|europe2|int|west1]
String of countries targetted (IN CN US...)
Only applicable when "int" zone is selected
Category ID
How many minutes will this job take
Must be higher than 30
Cost per task (example: 0.10, 0.13, 0.56,...)
Speed of campaign (1-1000) where 1000 is fastest
Description of what is required
Description of required proof
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 file as proof
2 - Workers are required to upload file as proof
(Optional) File as part of the Campaign
(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, error=[array of error messages*], min_payment_per_task=[min payment per task]
*[NO SUCH CAMPAIGN|INCORRECT SPEED VALUE]
Code:
cURL:
PHP:
Perl:
Python:
C#:
Examples:
Output (Success):
{
"status": "SUCCESS",
"campaign_id": "86f343b74104",
"cost": 3.975
}
Output (Error):
{
"status": "ERROR",
"errors": [
"POSITIONS",
"AUTO RATE"
],
"min_payment_per_task": 0.08
}