Retrieves statistics about employees in a workspace grouped by status.

Get employee statistics

EmployeeStatisticsPayload

apiKeyAuth

UnauthorizedErrorResponse

WorkspaceNotFoundErrorResponse

UnprocessableContentErrorResponse

RateLimitExceededErrorResponse

Riot Public API

Introduction

Lists all breaches for a workspace with their affected employees count and status.

List breaches

Lists all employees affected by a specific breach, ordered by their compromise date in descending order (most recent first).
The breach notification and acknowledgement dates, and breached email accounts are provided.


List compromised employees for a breach

Lists the campaigns for a workspace with its cycles, sorted by their creation date in descending order (most recent entries first).
A campaign cycle forms a group of attacks sent at a period of time. Periods of two cycles can't overlap.
Recurring campaigns usually have multiple cycles, whereas one-off campaigns usually have only one.


List campaigns

Retrieves a list of attacks of a campaign with associated events, sorted by their creation date in descending order (most recent entries first).

List attacks

Lists all active awareness courses of a workspace and their delivery settings.

List courses

Retrieves a paginated list of all employees and their progress across all courses in the workspace's awareness program.
For each employee, returns detailed information including their identification data and a comprehensive breakdown of their course progress.
The response includes the completion status of each course (completed, missed, or upcoming) for all program years up to the employee's current program year.


List all employees' courses progress

Retrieves statistics about awareness program in general for a given workspace. Feedbacks of only last 90 days are considered.

Get awareness program statistics

Lists all employees enrolled in the course, ordered by their creation date (most recent first).
The current year's enrolment status is provided, along with a history of course completion from previous years.


List courses status of employees

Retrieves a list of workspace employees, sorted by their creation date in descending order (most recent entries first).

API Documentation

Endpoints

Get employee statistics

Authorizations

Query Parameters

Response