GetRequesterWorkerStatistic - Amazon Mechanical Turk

WARNING

You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019.

If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019.

If you are on a legacy API, you must migrate to the latest version of our API. You can find documentation for the latest API here and the AWS SDKs here. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

GetRequesterWorkerStatistic

Description

The GetRequesterWorkerStatistic operation retrieves statistics about a specific Worker who has completed Human Intelligence Tasks (HITs) for you. If you have used Review Policies with known answers or plurality, Mechanical Turk will summarize the following statistics about the Worker's known answers and agreement level. These statistics are only for your Requester account. For more information about Review Policies, see Review Policies.

The following table describes the available statistics:

Name Description

NumberAssignmentsApproved

The number of assignments you have approved for the Worker.

Type: Long

NumberAssignmentsRejected

The number of assignments you have rejected for the Worker.

Type: Long

PercentAssignmentsApproved

The percentage of assignments approved, which is the Number of assignments approved divided by the number of assignments approved or rejected.

Type: Double

PercentAssignmentsRejected

The percentage of assignments rejected, which is the Number of assignments rejected divided by the number of assignments approved or rejected.

Type: Double

NumberKnownAnswersCorrect

The total number of known answer questions that the Worker has answered correctly.

Type: Long

NumberKnownAnswersIncorrect

The total number of known answer questions that the Worker has answered incorrectly.

Type: Long

NumberKnownAnswersEvaluated

The total number of known answer questions in assignments the Worker has submitted.

Type: Long

PercentKnownAnswersCorrect

The rounded percentage of known answer questions the Worker has answered correctly, which is the number of correct known answers divided by the number of known answers evaluated.

Type: Double

NumberPluralityAnswersCorrect

The number of evaluated questions that the Worker provided the agreed-upon answer for.

Type: Long

NumberPluralityAnswersIncorrect

The number of evaluated questions that the Worker did not provide the agreed-upon answer for.

Type: Long

NumberPluralityAnswersEvaluated

The number of evaluated questions answered by the Worker participating in the HIT.

Type: Long

PercentPluralityAnswersCorrect

The number of questions that the Worker provided the agreed-upon answer for, divided by the number of evaluated questions.

Type: Double

Request Parameters

The GetRequesterWorkerStatistic operation accepts parameters common to all operations. Some common parameters are required. For more information, see Common Parameters.

The following parameters are specific to the GetRequesterWorkerStatistic operation:

Name Description Required

Operation

The name of the operation.

Type: String

Valid Values: GetRequesterWorkerStatistic

Default: None

Yes

Statistic

The statistic to return.

Type: String

Valid Values: See the preceding available statistics table.

Default: None

Yes

WorkerId

The Worker you want to return the statistics for.

Type: String

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 GetRequesterWorkerStatistic operation has a GetStatisticResult element in the response.

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

Name Description

WorkerId

The Worker ID you are requesting the statistics for.

Type: String

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 data structure 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 GetRequesterWorkerStatistic operation.

Sample Request

The following GetRequesterWorkerStatistic operation request retrieves the number of assignments approved for the Worker ID A1Z4X5D207ALZF in the last 30 days.

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

Sample Response

The following is an example response where the Worker had 281 assignments approved in the last 30 days.

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