All Collections
Reporting
Security Journey API v3
Security Journey API v3

This article describes the v3 API, features and benefits.

Rachel Yonan avatar
Written by Rachel Yonan
Updated over a week ago

Security Journey provides Program Administrators access to a RESTful API; this can be used to generate custom reports within a BI tool or pull reporting metrics into your Learning Managment System (LMS) building management reports.

Generating an API Key

You must be a Security Journey Admin to have access to the API key generator. Keep in mind, if you are already using the v2 API and have an API key, the existing keys will work with the v3 API.
​
To generate a new API Key you will go to More > Admin > Settings > API. Follow the steps below:

  • Name your key

  • Click Generate

  • Copy the key and store it in a safe place

  • Click "Done"

If you don't click "Done" the key will not be saved and will be invalid. You should see this screen if the API Key was generated successfully.
​

Use this API key to authenticate against the v3 API by providing it in the Authorization header as a bearer token.

For example: Authorization: Bearer {my API token}

API Documentation

The v3 API route is: https://my.securityjourney.com/api/v3/public-reporting/{endpoint}
​

The available endpoints are:

Function

Endpoint

Users progress in their levels and paths

/api/v3/public-reporting/enrollments

Users Details

/api/v3/public-reporting/users

Users progress in assignments

/api/v3/public-reporting/assignments

Users lesson attempt data (lessons started & completed)

/api/v3/public-reporting/lesson-attempts

Users progress in their paths

/api/v3/public-reporting/progress

Our v3 API has improved query and filtering parameters, such as text search, status filtering, date range filtering, include/exclude archived users, etc.

We've included links to our postman collection, swagger documentation. These contain sample requests and responses in them:

Did this answer your question?