Getting Set Up With CyberPilot's Report API

Reporting is an important part of your cybersecurity training, since it will give you insight into how your training progresses. As an administrator, you can always find and download reports for your Awareness and Phishing training directly on the platform.

Fetching that same data through our Report API is also possible. This way, you can integrate your cybersecurity training into your business in an automated setup.

The Demonstration Account

If you would like to play around with our API, you can use our demonstration account, which has a lot of demo data in the reports.

Account ID: c36a9951-a630-4f5a-b874-160d4fe00d6f

The access token for the account is:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImI2YjYzNjM0LTY2ZDMtNGU1MC05YjkzLTJlN2ZlNWZlOTlmMCIsImNvbnRleHQiOnsiaXAiOiI6OmZmZmY6MTcyLjMyLjguMjA5In0sImF1ZCI6ImxvbmdfbGl2ZWRfdG9rZW4iLCJpcCI6Ijo6ZmZmZjoxNzIuMzIuOC4yMDkiLCJpYXQiOjE3NDU0NzcyNTcsImV4cCI6MTc3NzAxMzI1NywiaXNzIjoiQ3liZXIgUGlsb3QifQ.4FArir-Ni67Ht7dxQXTmZZtFqL_AHEl3SN7pG5Hb8-s

Authentication

Step 1: Activate the API

To get access to the Report API, you must first activate the API.

Go to "Account" and select the API pane.

Then, activate the API by enabling the toggle.

Your API is now activated, and ready to use.

Step 2: Obtaining an Access Token

To communicate with the API, you first must generate a Long Lived Access Token.

The Access Token will authorize you with the API and grant access to the endpoints you will communicate with.

Click the + Generate New Token button

A new token will be generated and available in the list below. The token will only be visible when generated, so make sure to copy the token right away.

It's possible to generate multiple tokens and name each token.

Important: The access token will expire 1 year after generation. When this year has passed, you will need to generate a new token.

Using the Access Token

For all requests to our API endpoints, you must have a valid, non-expired Access Token in the Authorization header.

The Access Token must be prefix with “bearer ”, so the full header will be: Authorization: bearer <ACCESS_TOKEN>.