Dashboard Analytics

Dashboard Analytics Service

APIs for DSS analytics dashboard primarily consists of 2 APIs. The one which is used to get configuration based on which the dashboard is painted. The other one is the API which gets the data needed for the visualization to paint different graphs.

API to get the Dashboard Configuration which gives the Visualizations and Layout to paint

get

This endpoint will pass the Dashboard ID from the URL to this API and will get the Dashboard Configuration from the backend which will have the details of the Visualization Layouts which are to be designed in this Dashboard.

Path parameters

dashboardIdstringRequired

ID of the Dashboard

Responses

200

Response for Success State of the API

application/json

400

Invalid input.

application/json

get

HTTPcURLJavaScriptPython

GET /dashboard/[APIEndPoint]/getDashboardConfig/{dashboardId} HTTP/1.1
Host: dev.digit.org
Accept: */*

{
  "statusInfo": {
    "statusCode": "text",
    "statusMessage": "text",
    "errorCode": 1,
    "errorMessage": "text"
  },
  "responseData": [
    {
      "name": "text",
      "id": "text",
      "isActive": true,
      "style": "text",
      "visualizations": [
        {
          "row": 1,
          "name": "text",
          "vizArray": [
            {
              "id": 1,
              "name": "text",
              "dimensions": {
                "height": 1,
                "width": 1
              },
              "vizType": "text",
              "charts": [
                {
                  "id": 1,
                  "name": "text",
                  "code": "text",
                  "chartType": "text",
                  "filter": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Get Chart API will be responding with the Data for each visualization based on the Chart ID which has been sent

post

Based on the Chart ID and the Visualization Type and the Request Dates and Filters, the API will aggregate the data and give the data which needs to be painted on Visualization Charts

Query parameters

contextPathstringOptional

httpMethodstring · enumOptionalPossible values:

locale.ISO3CountrystringOptional

locale.ISO3LanguagestringOptional

locale.countrystringOptional

locale.displayCountrystringOptional

locale.displayLanguagestringOptional

locale.displayNamestringOptional

locale.displayScriptstringOptional

locale.displayVariantstringOptional

locale.extensionKeysstring[]Optional

locale.languagestringOptional

locale.scriptstringOptional

locale.unicodeLocaleAttributesstring[]Optional

locale.unicodeLocaleKeysstring[]Optional

locale.variantstringOptional

nativeRequestobjectOptional

nativeResponseobjectOptional

notModifiedbooleanOptional

remoteUserstringOptional

securebooleanOptional

userPrincipal.namestringOptional

Header parameters

x-user-infostringOptional

x-user-info

Body

Responses

200

Response for Success State of the API

application/json

400

Invalid input.

application/json

post

HTTPcURLJavaScriptPython

POST /dashboard/[APIEndPoint]/getChartV2 HTTP/1.1
Host: dev.digit.org
Content-Type: */*
Accept: */*
Content-Length: 258

{
  "header": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "aggregationRequest": {
    "visualizationType": "text",
    "visualizationCode": "text",
    "queryType": "text",
    "filter": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "moduleLevel": "text",
    "requestDate": {
      "startDate": "text",
      "endDate": "text"
    }
  }
}

{
  "statusInfo": {
    "statusCode": "text",
    "statusMessage": "text",
    "errorCode": 1,
    "errorMessage": "text"
  },
  "responseData": [
    {
      "chartType": "text",
      "chartFormat": "text",
      "drillDownChartId": "text",
      "filter": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "data": [
        {
          "headerName": "text",
          "headerValue": 1,
          "headerSymbol": "text",
          "plots": [
            {
              "label": "text",
              "name": "text",
              "value": 1,
              "symbol": "text"
            }
          ]
        }
      ]
    }
  ]
}