The GetRequesterStatistic operation
retrieves the value of one of several statistics about you (the
Requester calling the operation).
Mechanical Turk keeps track of many statistics about users and
system activity. Statistics are calculated and recorded for
each calendar day. GetRequesterStatistic
can return data points for each of multiple days up to the
current day, or an aggregate value for a longer time period up
to the current day.
A single day's statistic represents the change in an overall
value that has resulted from the day's activity. For example,
the NumberAssignmentsApproved statistic
reports the number of assignments you have approved in a given
day. If you do not approve any assignments for a day, the value
will be 0 for that day. If you approve
fifty assignments that day, the value will be
50.
Similarly, for statistics represent values that both increase
and decrease with activity, the day's value will be a positive
or negative number that represents the change, or
0 if no change. For example,
NumberAssignmentsAvailable reports the
number of times Workers can accept an available HIT, totalled
over all available HITs. As you create more HITs, the total
goes up. As Workers accept your HITs, the total goes down. The
day's value will be the change in the total for the day. If you
created three HITs (each with a
MaxAssignments of
1) in a day, and Workers accepted five of
your HITs that day, then the value of the statistic for that day
will be -2.
For GetRequesterStatistic, a calendar day
begins at midnight in the Pacific time zone. U.S. daylight
saving time is followed, so a statistic for a day that
transitions to and from DST will represent one less or one more
hour of activity.
The following statistics are available:
| Name | Description | Long or Double? | ||
|---|---|---|---|---|
NumberAssignmentsAvailable
|
The number of times Workers can accept an available
HIT, totalled over all available HITs. In other
words, creating a HIT with a
| Long | ||
NumberAssignmentsAccepted
|
The number of times Workers have accepted your HITs. | Long | ||
NumberAssignmentsPending
|
The total number of assignments for your HITs that have been submitted by Workers and are awaiting approval. The total increases and decreases as assignments are submitted by Workers and approved or rejected by you. | Long | ||
NumberAssignmentsApproved
|
The number of assignments you have approved. | Long | ||
NumberAssignmentsRejected
|
The number of assignments you have rejected. | Long | ||
NumberAssignmentsReturned
|
The number of times Workers have returned assignments for your HITs. | Long | ||
NumberAssignmentsAbandoned
|
The number of times Workers have abandoned assignments (allowed the deadline to elapse without submitting results) for your HITs. | Long | ||
PercentAssignmentsApproved
|
The percentage of assignments that you have approved, over all assignments that you have approved or rejected. The percentage is represented as a decimal fraction between 0 and 1. The statistic value for a given day represents a change in the overall percentage due to activity for that day. | Double | ||
PercentAssignmentsRejected
| The percentage of assignments that you have rejected, over all assignments that you have approved or rejected. The percentage is represented as a decimal fraction between 0 and 1. The statistic value for a given day represents a change in the overall percentage due to activity for that day. | Double | ||
TotalRewardPayout
|
The total amount of the rewards paid for (approved) assignments. The amount is given in U.S. dollars. | Double | ||
AverageRewardAmount
|
The change in the average amount of the rewards paid for (approved) assignments. The amount is given in U.S. dollars. | Double | ||
TotalRewardFeePayout
|
The total amount of the HIT listing fees paid for (approved) assignments. The amount is given in U.S. dollars. | Double | ||
TotalFeePayout
|
The total amount of the HIT listing fees paid for (approved) assignments and bonus payments. The amount is given in U.S. dollars.
This statistic is deprecated, and may be
removed in a future version of the API. To
get the total amount of fees paid for rewards and
bonuses, get the
| Double | ||
TotalRewardAndFeePayout
|
The total amount of money paid for (approved) assignments, including both rewards and fees. The amount is given in U.S. dollars.
This total does not include fees
for bonus payments made with the
This statistic is deprecated, and may be
removed in a future version of the API. To
get the total amount of money paid for rewards and
reward fees, get the
| Double | ||
TotalBonusPayout
|
The total amount of the bonuses paid to Workers. The amount is given in U.S. dollars. | Double | ||
TotalBonusFeePayout
|
The total amount of the fees paid for bonus payments. The amount is given in U.S. dollars. | Double | ||
NumberHITsCreated
|
The number of HITs you created. | Long | ||
NumberHITsCompleted
|
The total number of your HITs that have been completed to their final state of either "disposed" or "disabled." | Long | ||
NumberHITsAssignable
|
The number of your HITs with a status of
| Long | ||
NumberHITsReviewable
|
The number of your HITs with a status of
| Long | ||
EstimatedRewardLiability
|
The total amount of all of the rewards for HITs and assignments that have not yet been completed. This includes the reward for each unclaimed assignment for HITs that have not yet expired, each assignment in progress, and each submitted assignment that has not yet been approved or rejected. This is an estimate, because it is possible that not all of a HIT's assignments will be completed before the HIT expires. The amount is given in U.S. dollars. | Double | ||
EstimatedFeeLiability
|
The total amount of all of the HIT listing fees for HITs and assignments that have not yet been completed at a given point in time. The amount is given in U.S. dollars. | Double | ||
EstimatedTotalLiability
|
The total amount of all of the rewards and fees for HITs and assignments that have not yet been completed at a given point in time. The amount is given in U.S. dollars. | Double |
The following example of a call to the
GetRequesterStatistic operation retrieves
the total reward payout for the thirty days leading up to the
current date.
http://mechanicalturk.amazonaws.com/onca/xml?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID]&Version=2006-10-31 &Operation=GetRequesterStatistic &Signature=[signature for this request]&Timestamp=[your system's local time]&Statistic=TotalRewardPayout &TimePeriod=ThirtyDays &Count=1
A request to the Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.
GetRequesterStatistic accepts parameters
common to all operations. Some common parameters are required.
See Common
Parameters for more information.
The following parameters are specific to the
GetRequesterStatistic operation:
| Name | Description | Type | Value |
|---|---|---|---|
Operation
|
The operation you would like to call. To access the
| Required |
|
Statistic
|
The name of the statistic to return. | Required |
A statistic name. See the table above for a list of statistic names. |
TimePeriod
|
The time period of the statistic to return. A statistic can be aggregated over several time periods: a one day period, a seven day period, a thirty day period, and the lifetime of your account. | Required |
|
Count
|
The number of data points to return. This parameter
is only used if
For example, if you specify a
| Required |
A positive integer |
A successful request for the
GetRequesterStatistic operation will have a
GetStatisticResult element in the
response.
The GetStatisticResult element contains a
DataPoint element for each value
requested.
Each DataPoint element contains the
following elements:
| Name | Description | Value |
|---|---|---|
Date |
The date represented by the data point. (For aggregate values, this is the current date.) |
A dateTime
in the Coordinated Universal Time (Greenwich Mean
Time) time zone, such as
|
LongValue
| DoubleValue
|
The value of the statistic over the time period beginning on the date. The element name and data type depend on which statistic was requested. |
A long or a double, corresponding to the element name |