This document lists and defines the attributes of the Units resource. Refer to the Figure Eight REST API document for comprehensive information about integrating with the Figure Eight API.
Please visit this link for our new Developer API Documentation.
Read-only Attributes
Note: In this article, rows are referred to as "units", auto launch is referred to as "auto order", and pages are referred to as "assignments".
The attributes listed in this section are read-only, but are returned in the JSON of many requests.
results |
||
Type |
Description |
Notes |
Object |
JSON object containing arrays of all Judgments received for the Unit designated in the request |
|
Any row that has gathered trusted judgments will also have a results
attribute.
results
has a top-level attribute judgments
, which contains a JSON array of all the Judgments that have been gathered so far during your job.
{ "results": { "judgments": [ ] }, "created_at": "2010-05-03T14:04:31-07:00", "data": { "name": "pirate radio" }, "updated_at": "2010-05-03T14:04:31-07:00", "judgments_count": 0, "id": 735275, "difficulty": 0, "job_id": 124056, "message": { "error": "Unit was successfully created, but it could not be ordered because channels have not been set for this job." }, "state": "new" }
Any aggregate calculations that are done on your data will also be included in results
. For example, if your job asks contributors to visit a website and answer a series of questions about the website, your results
structure might look like this:
{
"results": {
"what_is_the_url": {
"agg": "https://blog.figure-eight.com",
"confidence": "0.9"
}
}
}
See aggregation for more details on the types of aggregations that are possible.
updated_at |
||
Type |
Description |
Notes |
String |
Timestamp; the date and time at which the Row was last updated. | UTC Date/timestamp |
created_at |
||
Type |
Description |
Notes |
String | Timestamp; the date and time at which the Row was created. | UTC Date/timestamp |
judgments_count |
||
Type |
Description |
Notes |
Integer | The total number of Judgments the Row has received at the time of request |
id |
||
Type |
Description |
Notes |
Integer | Unique identifying number assigned to each Row by the platform | Usually nine bytes |
Read-write Attributes
missed_count |
||
Type |
Description |
Notes |
Integer | Indicates the number of times the Test Question was answered incorrectly |
|
difficulty |
||
Type |
Description |
Notes |
Integer |
state |
||
Type |
Description |
Notes |
String | The lifecycle state of the Row at the time of the request. | Values:
|
data |
||
Type |
Description |
Notes |
Object | Object containing column headers and data (as key-value pairs) for the Row indicated in the request | Contains the data uploaded for the Row and its created_at value |