


|  | 
| --- |
| **This software is not currently supported by Amazon Mechanical Turk** The Amazon Mechanical Turk Command Line Tools (CLT) are not currently maintained by Amazon Mechanical Turk. If you would still like to use Amazon Mechanical Turk from the command line, use the `mturk` command in the AWS Command Line Interface (CLI). For more information, see the `mturk` section of the [ AWS CLI Command Reference ](https://docs.aws.amazon.com/cli/latest/reference/mturk/index.html).  | 

 

# getResults
<a name="CLTReference_GetResultsCommand"></a>

## Description
<a name="w2aab9c37b2"></a>

 The `getResults` command retrieves the results of HITs submitted to Amazon Mechanical Turk. You must supply the name of a file that contains the IDs of the HITs. You can get this file from a call to [loadHITs](CLTReference_LoadHITsCommand.md). 

## Arguments
<a name="w2aab9c37b4"></a>

 The following table describes the arguments for the `getResults` command. 


| Name | Description | Required | 
| --- | --- | --- | 
|  `-help` or `-h`  |   Displays the help for this operation.  Example: `-help`  |  No  | 
|  `-namevaluepairs`  |   Outputs the results as name-value pairs instead of column format.  Example: `-namevaluepairs`  |  No  | 
|  `-outputfile [filename]`  |   Specifies the file in which the results are saved. For information about this file, see *The output file* in [Files Used by the Command Line Tools](CLTFilesArticle.md).  Example: `-outputfile helloworld.results`  |  Yes  | 
|  `-sandbox`  |   Runs this command in the Amazon Mechanical Turk sandbox for testing. This argument takes precedence even if you specify the production web site in your `mturk.properties` file.   Example:`-sandbox`   |  No  | 
|  `-successfile [filename]`  |   Specifies the path and name of the `.success` file that [loadHITs](CLTReference_LoadHITsCommand.md) returns. For information about this file, see *The success file* in [Files Used by the Command Line Tools](CLTFilesArticle.md).  Example: `-successfile helloworld.success`  |  Yes  | 

 This command creates an output file that contains the results of submitted HITs. The file contains all data related to the submitted HITs and assignments. Each HIT in this file has a link to your **Manage HITs** page on the [Requester website](http://requester.mturk.com/mturk/dashboard). Use these links to manually reject assignments, pay bonuses, or send emails to Workers. 

## Example
<a name="w2aab9c37b6"></a>

 The following examples for Unix and Windows show how to use the `getResults` command. 

### Unix
<a name="w2aab9c37b6b4"></a>

 The following example demonstrates how to call this command from Unix. 

```
./getResults.sh -successfile survey.success -outputfile survey.results
```

### Windows
<a name="w2aab9c37b6b6"></a>

 The following example demonstrates how to call this command from Microsoft Windows. 

```
getResults -successfile survey.success -outputfile survey.results
```

## Output
<a name="w2aab9c37b8"></a>

This example writes the results to the survey.results file and produces output similar to the following:

```
--[Retrieving Results]----------
Retrieved HIT 1/10, 832TY7YE5HKWS1H10YR0
Retrieved HIT 2/10, EW2ZHA4R3R7Z4WY5XZAZ
Retrieved HIT 3/10, 5YJ0T51KASD63A4J5YW0
Retrieved HIT 4/10, 0X5PSKYBVXNZPXZHCY0Z
Retrieved HIT 5/10, FWDE79ST7Y6A025QVXHZ
Retrieved HIT 6/10, X3YPN7HBFRXJ1KYMPGWZ
Retrieved HIT 7/10, YZJEZWZ3QW6Z28D9DG90
Retrieved HIT 8/10, 2J5Z5MZ91A06JFGRYYGZ
Retrieved HIT 9/10, PYMPVMRPPWVZTJN9RXE0
Retrieved HIT 10/10, N9PZZ0YW0Y9ZZQZPQH3Z
--[Done Retrieving Results]----------

Results have been written to file 'survey.results'.

Assignments completed: 30/30 (100%)
         Time elapsed: 0:05:16 (h:mm:ss)
  Average submit time: 13.7 seconds
```

## Related Commands
<a name="w2aab9c37c10"></a>

 
+  [approveWork](CLTReference_ApproveWorkCommand.md) 
+  [rejectWork](CLTReference_RejectWorkCommand.md) 