Clickworker - Reference of API calls available.

Clickworkers are the people working and fulfilling the customer’s tasks. In order to work on a task, a clickworker must meet specific prerequisites, such as being proficient in a specific language. In addition, clickworkers must pass a set of assessments and have gained a reasonable level of experience (“score”). Once they have a sufficient score, they may work on available jobs. For each product, clickworker.com controls which entry criteria must be met by a clickworker. Due to privacy concerns, data about individual clickworkers cannot be made public via the Marketplace API.

Operations

Unconditional access to clickworkers is not permitted due to privacy concerns. However, filters may be applied to select certain subsets of the clickworker user base. Methods are provided to make sure there are clickworkers available to handle certain tasks. Calling these methods requires additional request parameters to be provided.

Count Clickworkers In Radius

Counts all clickworkers within a given radius. Its geographical center and radius describe the range. The minimum radius allowed is 10 kilometers (6.2 miles); smaller radiuses will be adjusted accordingly.

Request

Request line:

GET [context]/clickworkers?api_method=count_in_radius&latitude=${latitude}&longitude=${longitude}&r=${radius}

Request parameters:

Name Type Synopsis Mandatory
latitude Numeric The latitude of the geographical center Yes
longitude Numeric The longitude of the geographical center Yes
r Integer The radius in kilometers Yes

Response

Response status:

  • 200, if the request could be handled properly (even if no clickworkers were found)

XML Example

<clickworkers_response>
  <request_status>...</request_status>
  <clickworker_count> 9200 </clickworker_count>
  </clickworkers_response>
  </clickworkers_response>
</clickworkers_response

JSON Example

clickworkers_response: {
  request_status: { ... },
  clickworker_count: 9200
}

Count Clickworker in Bounding Box

Counts all clickworkers located within a given area. Its geographical boundaries (southwest and northeast corners) describe a square area. The minimum latitude / longitude difference of the two corner coordinates must be equivalent to an area of at least 10km^2 (3.9 square miles). If a smaller area is defined, it will maintain the southwest origin and expand.

Request

Request line:

GET [context]/clickworkers?api_method=count_in_bounding_box&sw_latitude=${sw-lat}&sw_longitude=${sw-long}    &ne_latitude=${ne-lat}&ne_longitude=${ne-long}

Request parameters:

Name Value(s) Synopsis Mandatory
sw_latitude Numeric The latitude of the box’s southwest coordinate Yes
sw_longitude Numeric The longitude of the box’s southwestcoordinate Yes
ne_latitude Numeric The latitude of the box’s northeastm coordinate Yes
ne_longitude Numeric The longitude of the box’s northeast coordinate Yes

Response

Response status:

  • 200, if the request could be handled properly (even if no clickworkers were found) (Identical to the response body of operation “Count Clickworkers In Radius”)

Response body

(Identical to the response body of operation “Count Clickworkers In Radius)

Tags: