"POST /openapi/v1/report" method

Generate report data about users who are registered on the portal and are completing training on ASAP applications.

The size of the passed data is described in the body of the request.

Request

Header:

• Authorization – the company's API token.

Body:

• lng – a string – the language code of the language used for the report. One of the available localization languages in ISO 639-1 format. Required. It is indicated in lowercase letters.

  Mapping between the report language and value of lng

  Locale	Language code / subfolder name
  English	en
  Bahasa Indonesia	id
  Bosanski	bs
  Català	ca
  Čeština	cs
  Dansk	da
  Deutsch	de
  Ελληνικά	el
  Español (España)	es
  Español (México)	mx
  Français	fr
  Հայերեն	hy
  Hrvatski	hr
  Italiano	it
  Қазақша	kk
  Magyar	hu
  Nederlands	nl
  Polski	pl
  Português (Brasil)	br
  Português (Portugal)	pt
  Română	ro
  Русский	ru
  Slovenský	sl
  Slovenský	sk
  Srpski	sr
  Svenska	sv
  Tiếng Việt	vi
  Türkçe	tr
  العربية	ar
  ไทย	th
  日本語	ja
  简体中文	cn
  繁體中文（香港）	zh

• email – an array – the user's email address. Indicated to get data on a specific user. Optional.

  Requirements on indicated addresses: 1) they must be indicated in lowercase letters, 2) they must contain the symbols "@" and ".".

• page – type int – number of the page with the report. When accessing the API, no more than 500 records are displayed in the response. If there are more users in the report, then to view records over 500 you must additionally specify the report page. Optional.

  For example, to view the 501st record of the report, set the "page": 2 parameter.

Example of the body of a request: {     "lng":"en",     "email":["example@email.com","jackrockstar88@email.com"],     "page":1 }

Response

JSON containing an array of data about each user:

• id – a string – the ID assigned to the employee on the ASAP platform.
• email – a string – the email addressed used to register the user.
• shortName – a string – The user's registered short name.
• fullName – a string – The user's registered full name.
• group – a string – The user's current training group.
• educationTime – a string – Length of training in seconds.
• mainEducationProgress – a string – Performance category in the main course.
• expressEducationProgress – a string – Performance category in the express course.
• educationStatus – a string – Current training status.
• mainEducationProgressPercent – a float – Training progress in the main course, expressed as a percentage in the format xx.xx.
• expressEducationProgressPercent – a float – Training progress in the express course, expressed as a percentage in the format xx.xx.
• mainEducationEndPlan – a date – Planned date for completion of the main course.
• expressEducationEndPlan – a date – Planned date for completion of the express course.
• realMainEducationEnd – a date – Date of completion of the main course.
• realExpressEducationEnd – a date – Date of completion of the express course.
• educationMainCourses – an array – Training courses and training status in the main course. Response format.
• educationExpressCourses – an array – training courses and training status in the express course. Response format.
• dateLastActive – a date – The date of the most recent activity, in a format that depends on the input localization language.
• certificatesReceived – an int – The total number of certificates received by the user during training.

  If the user has not started training or has not received any certificates, "0" is returned.

• phishingAttacks – an array – Information about a phishing attack during training on the ASAP platform. Response format.

Example of a response

{ "id":"60e050803050c0704080a0e060", "email":"jackrockstar88@email.com", "shortName":"Jack", "fullName":"Jack Rock", "group":"Low Risk", "educationTime":840, "mainEducationProgress":"Behind schedule", "expressEducationProgress":"In progress", "educationStatus":"not started", "mainEducationProgressPercent":"50.00", "expressEducationProgressPercent":"14.80", "mainEducationEndPlan":"2022-08-08", "expressEducationEndPlan":"0001-01-01", "realMainEducationEnd":"0001-01-01", "realExpressEducationEnd":"0001-01-01", "educationMainCourses": [   {   code: 'Password',   level: 1 || null,   status: 0 || 1 || 2   startedAt: ''   finishedAt: '' || null,   } ], "educationExpressCourses": [   {   code: 'Password',   level: 1 || null,   status: 0 || 1 || 2   startedAt: ''   finishedAt: '' || null,   } ], "dateLastActive":"2022-08-08", "certificatesReceived":2, "phishingAttacks": [   {   code: 'Password',   level: 1   startedAt: '2022-09-09T18.00.00.0Z',   phishingAttackLetter: 'Hallo!',   phishingAttackResult: '0',   followPhishingLinkAt: null } ] }

Possible errors

• 200 – success – The operation succeeded.
• 401 - common-unauthorized - There was an authentication error.
• 404 – user not found – An invalid email address was sent.
• 400 – bad request – Something is wrong with the request.
• 500 – internal-server-error – There was an internal server error.

To the top