Skip to main content

[API Endpoint] Scores

Samantha L Cook
Updated 
https://teachboost.com/api/v1/scores
  • 15 requests are allowed every 60 seconds.

Options

offset: Integer

  • You can filter results by setting a starting point using this "offset" option; for instance, to return "only forms after the 1000th form"
  • Default is 0
  • Format: --data "offset=1000"

limit: Integer

  • Set the total number of scores to return using the "limit" option; for instance, to return only the first 100 scores/ratings
  • Default and max is 1000
  • Format: --data "limit=100"

start_date: DateTime

  • This option sets the beginning of a time bound with which to filter results
  • Format: --data "start_date=2017-01-01 00:00:00"

end_date: DateTime

  • Similar to start_date, use this option to set the end of a time bound with which to filter your results
  • Format: --data "end_date=2017-01-31 23:59:59"

Sample Object

{
    score_id: 507f191e810c19729de860ea,
    score: 3,
    label: 'Effective',
    form_id: 324516,
    form_type: informal_obs,
    template_id: 1207,
    topic_id: 136061,
    author_ids: [
        84413
    ],
    date: '2016-04-04 00:00:00',
    group_id: 10,
    group_ids: [
        15501, 16770
    ],
    hidden_from: [
        142145
    ],
    competency_ids: [
        '380-3', '380-3.1'
    ],
    x_competency_ids: [
        '380-3.1'
    ]
}

Returned Fields

  • score_id: String, 32 characters, internal UID for this score record.
  • score: Integer, score or rating value. When there is no score, the value is empty (note that this is a change where we would previously send -1. A value of 0 is a valid score.
  • label: String, label from the rating scale corresponding to the score value
  • form_id: Integer, internal ID of the Form this score is linked to
  • form_type: String, internal identifier for the linked Form's type
  • template_id, Integer, internal ID of the Template this Form utilizes
  • topic_id: Integers, User ID if the topic whom this score is about
  • author_ids: Array of Integers, collection of User IDs who are authors of the linked Form
  • date: DateTime, the date and time of the Score
  • group_id: Integer, internal ID of the Group for this Score
  • group_ids: Array of Integers, collection of all Groups that have access to this Score
  • hidden_from: Array of Integers, collection of User IDs who explicity do not have access to this Score. Usually the topics of the linked Form if the Form is not shared to the topics.
  • competency_ids: Array of Strings, the internal IDs of the Competencies (see Framework object) that are attached to this score. This contains the Competencies that were attached as well as any parents to those Competencies.
  • x_competency_ids: Array of Strings, the internal IDs of the Competencies (see Framework object) that are attached to this score. This field only contains the explicity linked Competencies.

Related articles