API Docs

Main Routes

• /comments
• /classifications
• /classifications/:user_id
• /classifications/:user_group_id

/comments

The following are all allowable params for /comments (we also allow combinations of params in order for our users/clients to view more detailed responses depending on what they query). Callout examples and responses can be found here

• /comments : will return total_count of comments of all time
• /comments?start_date=__&end_date=__ : returns total_count of comments between that date range (you can also query by just start_date or by just end_date)
• /comments?period=day : will return total_count of comments of all time and the breakdown of comment counts bucketed by the period (this breakdown lives in data attribute of response).
  • period can either be:
    • day
    • week
    • month
    • year
• /comments?project_id=__: will return total_count of comments for given project_id/s. We can search by multiple projects.
  (Eg. /comments?project_id=1,2. Note that project_ids are separated by ,.)
  NOTE: that when searching by multiple projects, ERAS will not break up counts by project, but rather total it up. (Same thing with user_id/s for counting comments and workflow_id/s for counting classifications)
• /comments?user_id= : will return total_count of comments for given user_id/s. Similar to ?project_id but with users.
  NOTE: this callout by user_id does not require any authorizations. Reasoning behind this is that all comments are viewable in Talk anyway. In this way, we get a simpler implementation.

/classifications

• /classifications => will return total_count of classifications of all time
• /classifications?start_date=&end_date= => returns total_count of classifications between that date range (you can also just have start_date or just have end_date
• /classifications?period=day => will return total_count of classifications of all time and breakdown of classification count bucketed by period. Period only allows day, week, month, year as allowed buckets.
• /classifications?workflow_id= => will return total_count of classifications for given workflow_id/workflow_ids. Can search by multiple workflows.
  (Eg. /classifications?workflow_id=1,2 workflow_ids separated by ,.)
  
  • But note that when searching by multiple workflows, ERAS will not break up counts by workflow but rather total it up..
    
  • For simplicity sake, we do not allow search by BOTH workflow_id and project_id, mainly to save a check to Panoptes to see if workflow/s belong to project/s (i.e. a callout to /classifications?workflow_id=1,2&project_id=3 is NOT valid. Either search by workflow_id or project_id)
• /classifications?project_id= => will return total_count of classifications for given project_id/s. Similar to ?workflow_id but this time with projects.

/classifications/:user_id

/classifications/:user_group_id