GetBonuses: Get Bonus Payments

In cloudyr/pyMTurkR: A Client for the 'MTurk' Requester API

Get Bonus Payments

Description

Get details of bonuses paid to workers, by HIT, HITType, Assignment, or Annotation.

Usage

GetBonuses(
  assignment = NULL,
  hit = NULL,
  hit.type = NULL,
  annotation = NULL,
  results = as.integer(100),
  pagetoken = NULL,
  verbose = getOption("pyMTurkR.verbose", TRUE)
)

Arguments

assignment	An optional character string containing an AssignmentId whose bonuses should be returned. Must specify assignment xor hit xor hit.type xor annotation.
hit	An optional character string containing a HITId whose bonuses should be returned. Must specify assignment xor hit xor hit.type xor annotation.
hit.type	An optional character string containing a HITTypeId (or a vector of HITTypeIds) whose bonuses should be returned. Must specify assignment xor hit xor hit.type xor annotation.
annotation	An optional character string specifying the value of the RequesterAnnotation field for a batch of HITs. This can be used to retrieve bonuses for all HITs from a “batch” created in the online Requester User Interface (RUI). To use a batch ID, the batch must be written in a character string of the form “BatchId:78382;”, where “73832” is the batch ID shown in the RUI. Must specify assignment xor hit xor hit.type xor annotation.
results	An optional character string indicating how many results to fetch per page. Must be between 1 and 100. Most users can ignore this.
pagetoken	An optional character string indicating which page of search results to start at. Most users can ignore this.
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('pyMTurkR.verbose', TRUE).

Details

Retrieve bonuses previously paid to a specified HIT, HITType, Assignment, or Annotation.

bonuses(), getbonuses(), ListBonusPayments() and listbonuspayments() are aliases.

Value

A data frame containing the details of each bonus, specifically: AssignmentId, WorkerId, Amount, Reason, and GrantTime.

Author(s)

Tyler Burleigh, Thomas J. Leeper

References

API Reference

See Also

GrantBonus

Examples

## Not run: 
# Get bonuses for a given assignment
GetBonuses(assignment = "26XXH0JPPSI23H54YVG7BKLO82DHNU")

# Get all bonuses for a given HIT
GetBonuses(hit = "2MQB727M0IGF304GJ16S1F4VE3AYDQ")

# Get bonuses from all HITs of a given batch from the RUI
GetBonuses(annotation = "BatchId:78382;")

## End(Not run)

cloudyr/pyMTurkR documentation built on April 7, 2024, 12:07 p.m.