Batches API

Get counts of total, submitted, and complete comparisons for batch

GET /api/batches/:batch_id/status

Parameters

Name : batch_id - required - Description : Batch ID

Name : email - required - Description : Email addresss

Name : auth_token - required - Description : Auth Token

Request

Headers



Route

GET /api/batches/705/status?email=researcher5%40university.edu&auth_token=BvmvjAwHRbz7KG-AmMbk

Query Parameters

email: researcher5@university.edu
auth_token: BvmvjAwHRbz7KG-AmMbk

Response

Headers

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

Status

200 OK

Body

{
  "id": 705,
  "comparisons": {
    "total_count": 4,
    "submitted_count": 3,
    "completed_count": 1,
    "expired_count": 1
  }
}