Comparisons API

Create multiple comparisons in a specified batch (multiple comparisons per HIT)

POST /api/comparisons/create.json

If you have many comparisons, you may want more than one comparison per HIT for cost-effectiveness

Parameters

Name : ids - required - Description : Document IDs

Name : email - required - Description : Email addresss

Name : auth_token - required - Description : Auth Token

Name : question Description : Question

Name : batch_id Description : Batch ID

Name : template_id Description : Template ID

Name : template_properties Description : Template Properties

Request

Headers



Route

POST /api/comparisons/create.json

Body

{"question":"Question text","ids":[[495,496],[497,498]],"batch_id":2210,"comparisons_per_hit":2,"email":"researcher34@university.edu","auth_token":"nrmn16eFG922wxkGVpHX"}

Response

Headers

Content-Type: application/json; charset=utf-8

Status

200 OK

Body

{
  "batch_id": 2210
}