GetRequesterStatistic

Description

The GetRequesterStatistic operation retrieves statistics about you (the Requester calling the operation). The following table describes the available statistics:

Name	Description
NumberAssignmentsAvailable	DEPRECATED* as of 11/01/2016 - The number of times Workers can accept an available HIT, totaled over all available HITs. In other words, a HIT with 3 MaxAssignments can be described as having 3 available assignments, each of become Accepted when a Worker accepts the HIT. (Technically, Amazon Mechanical Turk does not create an assignment with an assignment ID until a Worker accepts a HIT.) Type: Long
NumberAssignmentsAccepted	DEPRECATED* as of 11/01/2016 - The number of times Workers have accepted your HITs. Type: 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. Type: Long
NumberAssignmentsApproved	The number of assignments you have approved. Type: Long
NumberAssignmentsRejected	The number of assignments you have rejected. Type: Long
NumberAssignmentsReturned	DEPRECATED* as of 11/01/2016 - The number of times Workers have returned assignments for your HITs. Type: Long
NumberAssignmentsAbandoned	The number of times Workers have abandoned assignments (allowed the deadline to elapse without submitting results) for your HITs. Type: Long
PercentAssignmentsApproved	The percentage of assignments that you have approved, computed 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. Type: Double
PercentAssignmentsRejected	The percentage of assignments that you have rejected, computed 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. Type: Double
TotalRewardPayout	The total amount of the rewards paid for approved assignments. The amount is given in U.S. dollars. Type: Double
AverageRewardAmount	The change in the average amount of the rewards paid for approved assignments. The amount is given in U.S. dollars. Type: Double
TotalRewardFeePayout	The total amount of the HIT listing fees paid for approved assignments. The amount is given in U.S. dollars. Type: 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. To get the total amount of fees paid for rewards and bonuses, get the TotalRewardFeePayout statistic and the TotalBonusFeePayout statistic and add them together. Type: Double
TotalRewardAndFeePayout	The total amount of money paid for approved assignments, including rewards and fees. The amount is given in U.S. dollars. This total does not include fees for bonus payments made with the GrantBonus operation. This statistic is deprecated. To get the total amount of money paid for rewards and reward fees, get the TotalRewardPayout and TotalRewardFeePayout statistics and add them together. Type: Double
TotalBonusPayout	The total amount of the bonuses paid to Workers. The amount is given in U.S. dollars. Type: Double
TotalBonusFeePayout	The total amount of the fees paid for bonus payments. The amount is given in U.S. dollars. Type: Double
NumberHITsCreated	The number of HITs you created. Type: Long
NumberHITsCompleted	The total number of your HITs that have been completed to their final state of either Disposed or Disabled. Type: Long
NumberHITsAssignable	The number of your HITs with status Assignable. Note NumberHITsAssignable can only be queried as a LifeToDate value. While most statistics change in real time, a day's value for this statistic is added to the LifeToDate total at the end of the day. Type: Long
NumberHITsReviewable	The number of your HITs with status Reviewable. Type: 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. Type: 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. Type: 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. Type: Double

*Deprecated statistics are not expected to be accurate. The GetRequesterStatistic operation may return an exception when a deprecated metric is requested.

Request Parameters

The GetRequesterStatistic operation 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	Required
Operation	The name of the operation Type: String Valid Values: GetRequesterStatistic Default: None	Yes
Statistic	The statistic to return Type: String Valid Values: See the preceding table. Default: None	Yes
TimePeriod	The time period of the statistic to return. Type: String Valid Values: OneDay | SevenDays | ThirtyDays | LifeToDate Default: None	Yes
Count	The number of data points to return Type: positive integer Default: 1 Conditions: only used if TimePeriod is OneDay For example, if TimePeriod is OneDay and Count is 12, the operation returns 12 data points for the statistic, one for each of 12 calendar days leading up to the current date, including the current day.	Conditional

Response Elements

A successful request for the GetRequesterStatistic operation has a GetStatisticResult element in the response.

The GetStatisticResult element contains a the following elements for each value requested.

Name	Description
Statistic	The named statistic you specified in the Request. See the preceding table for a list of statistics. Type: String
TimePeriod	The time period you specified in the Request. Type: String
DataPoint	The data point data structure described in the next table. Type: DataPoint structure

Each DataPoint element contains the following elements:

Name	Description
Date	The date represented by the data point. For aggregate values, this is the current date. Type: A dateTime structure in the Coordinated Universal Time (Greenwich Mean Time) time zone, such as 2005-01-31T23:59:59Z
LongValue | DoubleValue	The value of the statistic over the specified time period. The element name and data type depend on which statistic was requested. Type: a long or a double, depending on the requested statistic.

Examples

The following example shows how to use the GetRequesterStatistic operation.

Sample Request

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.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2011-09-01
&Operation=GetRequesterStatistic
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&Statistic=NumberAssignmentsApproved
&TimePeriod=ThirtyDays
&Count=1

Sample Response

The following is an example response.

<GetStatisticResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <Statistic>NumberAssignmentsApproved</Statistic>
  <TimePeriod>ThirtyDays</TimePeriod>
  <DataPoint>
    <Date>2011-09-05T07:00:00Z</Date>
    <DoubleValue>281</DoubleValue>
  </DataPoint>
</GetStatisticResult>