Generate high level reports

This scenario shows how to generate high level Circularo reports. Due to the security reasons and the reports complexity, there is a predefined set of reports that can be generated.

You can find the list of available reports in the settings object. This is the current list of the reports: trans_status,trans_success_per_date,trans_per_date,docs_per_user,trans_consumption,trans_per_user,docs_consumption,docs_per_state,trans_per_avg.

Read more about the reports - Reports

Step 1 - Sign in

Sign user in.

Endpoint

POST /login

Request

POST /login

Content-Type: application/json

{
  "name": "mary.griffin@circularo.com",
  "password": "#32Password1!",
  "tenant": "default"
}

Response

Note following properties in response object:

• token - In response object at position token.

  • It may have value of QjqS0TPbRGzYAj3bZTBrOQ1k8uKuTggxPGr4q6X5SNDEdo9cWqfz6v5SobQq61v3.

• allowedDashboards - In response object at position settings.data.allowedDashboards.

  • It may have value of:

    JSON

    [
      "trans_status",
      "trans_success_per_date",
      "trans_per_date",
      "docs_per_user",
      "trans_consumption",
      "trans_per_user",
      "docs_consumption",
      "docs_per_state",
      "trans_per_avg"
    ]

Step 2 - Generate high level report(s)

Using this request, you can generate one or multiple high level reports.

List of available reports is part of the settings, you can see it e.g. in response object after the user logs in.

Endpoint

POST /search/dashboards

Request

POST /search/dashboards?token=QjqS0TPbRGzYAj3bZTBrOQ1k8uKuTggxPGr4q6X5SNDEdo9cWqfz6v5SobQq61v3

Content-Type: application/json

{
  "dashboards": [
    {
      "name": "docs_per_state"
    }
  ]
}

Response contains data for each generated report. The reported values in results.values property match the properties.datasetLabels labels.