Analytics

Analytics APIs

API specs to configure dashboard visualisations and fetch data for the configured visualisations.

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

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.

get

/getDashboardConfig/{dashboardId}

Path parameters

dashboardIdstringrequired

ID of the Dashboard

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://dev.digit.org/dashboard/[APIEndPoint]/getDashboardConfig/{dashboardId}'

200

400

200

{
  "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"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Response for Success State of the API

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

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

post

/getChartV2

Query parameters

contextPathstring

httpMethodstring · enum

Options: DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, TRACE

locale.ISO3Countrystring

locale.ISO3Languagestring

locale.countrystring

locale.displayCountrystring

locale.displayLanguagestring

locale.displayNamestring

locale.displayScriptstring

locale.displayVariantstring

locale.extensionKeysstring[]

locale.languagestring

locale.scriptstring

locale.unicodeLocaleAttributesstring[]

locale.unicodeLocaleKeysstring[]

locale.variantstring

nativeRequestobject

nativeResponseobject

notModifiedboolean

remoteUserstring

secureboolean

userPrincipal.namestring

Header parameters

x-user-infostring

x-user-info

Body

aggregationRequestobject

headerobject

A map of String and and String to hold the Header Filters which are applied on this dashboard

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev.digit.org/dashboard/[APIEndPoint]/getChartV2' \
  --header 'Content-Type: */*' \
  --data '{"aggregationRequest":{"requestDate":{},"filter":{}},"header":{}}'

200

400

200

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Response for Success State of the API