LMS Collaborator knowledge base

Home/Technical requirements/API/API - Summary Report

API – Summary Report

  • To get a summary report for any task you need to send POST request to the following URI
    https://localhost:8080/api/v2/tasks/summary-report
  • The request body should contain JSON object with information about selected users and tasks.
  • The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:
curl -X POST 'https://localhost:8080/api/v2/tasks/summary-report' --data-raw '{"page":1,"count":10,"filter":{},"sorting":{"user_full_name":"asc"},"filterData":{"tasks":[123],"users":[123]}}'
-H 'Authorization: Bearer xxxxxx'
-H 'Content-Type: application/json;charset=UTF-8'


Answer

In case of successful request (HTTP response code - 200), the following result will be returned:

data - results array
pager - pagination object (information about the number of pages, the current page, the number of results)

The request supports filtering by the following fields:

  • fullname - Name
  • position - Position
  • city - City
  • department - Department
  • tags - tag

In case of error(HTTP response code - 400) it returns JSON object with error information

Still have questions?
Our technical support team is always happy to help!
Write to us at technical support [email protected]. If you are registered on our Helpdesk - send request button below.
Send request