API: Awareness Training Summary

This API will give you a summary of all course enrollments in your account. You'll get detailed information for each course enrolled, letting you know how did each user do on each course.

Request

URL: https://api.app.cyberpilot.io/accounts/{account-id}/reports/users-awareness
Method: GET
Parameters:

Parameter	Type	Default Value	Description	Example
Authorization	Header		The value of this header must be your Access Token prefix with “bearer “.	Bearer eyJhbGciOiJSUzI1N
account-id	Path		The ID of your account. You can find this in the API section of your Account settings on the platform	c36a9951-a630-4f5a-b874-160d4fe00d6f
take	Query	20	How many courses to return summary for.
skip	Query	0	How many courses to skip (offset). Take and skip combined can be used as pagination.

Response

Important: The API will return more properties than specified below, but these properties are not actively supported and should not be relied upon. They may be removed in the future.

{ 
  count: int // How many courses has been enrolled to users 
  fetched: int // How many courses was fetched in this request. (See the “take” query parameter) 
  result: array [ // A summary for each course enrollment 
    { 
      course: object { // Details of the course 
        id: string 
        name: string 
        type: string // “course” or “material” 
      }  
      user: object { // Information about the user 
        id: string 
        email: string 
        created: datetime 
        name: string 
        firstName: string 
        lastName: string 
        branch: object { // Information of a branch the user might be part of. 
          id: string 
          name: string 
        } 
        enrollmentDate: datetime // The datetime the user was enrolled into the course 
        dueDate: datetime // The datetime when the course should be completed 
        bestAttempt: object | null { // If the user completed the course multiple times, this is the best attempt 
          status: string // One of “in-progress”, “completed” or “failed” 
          score: int // The score for the attempt (0-100) 
          completed: datetime // When the attempt was completed 
        }, 
        status: string // One of “in-progress”, “completed” or “failed” 
    }, 
    …, 
  ] 
}

Got a question?