mturk_list_bonus_payments: The ListBonusPayments operation retrieves the amounts of...

Description Usage Arguments Value Request syntax

View source: R/mturk_operations.R

Description

The list_bonus_payments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

Usage

1
mturk_list_bonus_payments(HITId, AssignmentId, NextToken, MaxResults)

Arguments

HITId

The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified

AssignmentId

The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified

NextToken

Pagination token

MaxResults

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  NumResults = 123,
  NextToken = "string",
  BonusPayments = list(
    list(
      WorkerId = "string",
      BonusAmount = "string",
      AssignmentId = "string",
      Reason = "string",
      GrantTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

1
2
3
4
5
6
svc$list_bonus_payments(
  HITId = "string",
  AssignmentId = "string",
  NextToken = "string",
  MaxResults = 123
)

paws.analytics documentation built on March 8, 2021, 1:10 a.m.