Read Activity Metrics

After login, the activity metrics can be requested for the authenticated subscriber.

This is usually called when the login authentication API has been successful to return the activity metrics configuration.

Read App Studio Designed Activity Metrics

POST AppStudio/ReadActivityMetrics

This is a POST method which passes both the API and session keys as headers, and a body. If successful, the app toolbar can be displayed.

Headers

Name	Value
Content-Type	application/json
SiteKey	API Key
DataServicesKey	Session Key

Body

Name	Type	Description
TreeFormat	Boolean	true

Response

200

{
  "Success": true,
  "JSON": "base64 encoded string"
}

400

{
  "error": "Invalid request"
}

Base64 JSON Decoding

The JSON data is Base64 encoded. You must decode this into a JSON string and convert that into a multi-hierarchical object.

This example shows the activity metric KPI's on the rendered app on the left and a matching portion of the multi-hierarchical object returned from the API.

Scheduling Frequency

How often the ReST API requests should be called to refresh the display of each KPI is determined by these properties.

"FrequencyVisible": true,
"Frequency": "30 Seconds

In this example, we call this API every 30 seconds for each visible metric using the RequestId of the ReST API data source request:

"DataSourceRequest": {
            "RequestId": "6a6c9c63-cb33-1c47-2fdb-751d2642e1a3",
            "Type": "Read"
}

The data returned for metrics is usually simply a number, for example:

{  
  "DataTable": {
    "List": [
      {
        "count": 24
      }
    ]
  }
}

.. and this specific metric would be displayed like this:

Example Response JSON

Here is an example of the full activity metrics.

[
  {
    "text": "Activity Metrics",
    "icon": "gi gi-charts",
    "data": {
      "Type": "Root",
      "Locked": true,
      "ID": "3bc36fcb-f506-4ba7-99b4-bf278b59e73b",
      "Name": "Activity Metrics",
      "Description": "List of activity metrics available on both navigation bar and toolbar account summary drop down menu",
      "Caption": "Activity Metrics",
      "Icon": "gi gi-charts",
      "Visible": true,
      "CaptionVisible": true,
      "TooltipVisible": false,
      "IconVisible": false,
      "FormVisible": false,
      "VisibleVisible": true,
      "StyleVisible": false,
      "DataSourceVisible": false,
      "FrequencyVisible": true,
      "Frequency": "30 Seconds"
    },
    "items": [
      {
        "text": "Clubs/Teams",
        "icon": "gi gi-building",
        "data": {
          "Type": "Metric",
          "ID": "4de7f79c-872d-64cb-ed36-e24f7b663c22",
          "Name": "qq",
          "Description": "Added by Josie Musto on Tuesday 20 May 2025",
          "Caption": "Clubs/Teams",
          "Icon": "gi gi-building",
          "Visible": true,
          "CaptionVisible": true,
          "TooltipVisible": true,
          "IconVisible": true,
          "FormVisible": true,
          "VisibleVisible": true,
          "StyleVisible": true,
          "Style": "Red",
          "Tooltip": "Count of football teams",
          "DataSourceVisible": true,
          "DataSourceRequest": {
            "RequestId": "6a6c9c63-cb33-1c47-2fdb-751d2642e1a3",
            "Type": "Read"
          },
          "Form": "Clubs",
          "FrequencyVisible": false
        },
        "items": []
      },
      {
        "text": "Footballers",
        "icon": "gi gi-soccer_ball",
        "data": {
          "Type": "Metric",
          "ID": "2f050f05-9287-e8b9-e6f6-62b6aa9d33bd",
          "Name": "Golf",
          "Description": "Added by Josie Musto on Tuesday 20 May 2025",
          "Caption": "Footballers",
          "Icon": "gi gi-soccer_ball",
          "Visible": true,
          "CaptionVisible": true,
          "TooltipVisible": true,
          "IconVisible": true,
          "FormVisible": true,
          "VisibleVisible": true,
          "StyleVisible": true,
          "Style": "Yellow",
          "Tooltip": "Number of football players",
          "DataSourceVisible": true,
          "DataSourceRequest": {
            "RequestId": "3fc781bc-0035-3716-4db3-48e415596cb1",
            "Type": "Read"
          },
          "Form": "Footballers",
          "FrequencyVisible": false
        },
        "items": []
      },
      {
        "text": "Nationalities",
        "icon": "gi gi-globe_af",
        "data": {
          "Type": "Metric",
          "ID": "24e8c094-1253-ff02-0684-2260dfb82196",
          "Name": "goo goo",
          "Description": "Added by Josie Musto on Tuesday 20 May 2025",
          "Caption": "Nationalities",
          "Icon": "gi gi-globe_af",
          "Visible": true,
          "CaptionVisible": true,
          "TooltipVisible": true,
          "IconVisible": true,
          "FormVisible": true,
          "VisibleVisible": true,
          "StyleVisible": true,
          "Style": "Blue",
          "Tooltip": "Number of nationalities",
          "Form": "Nationalities",
          "DataSourceVisible": true,
          "FrequencyVisible": false,
          "DataSourceRequest": {
            "RequestId": "28120411-73f2-b0a4-2117-1cf5f1c28546",
            "Type": "Read"
          }
        },
        "items": []
      },
      {
        "text": "Positions",
        "icon": "gi gi-playing_dices",
        "data": {
          "Type": "Metric",
          "ID": "2d25ff20-efec-4d48-053c-b58ffe5a7429",
          "Name": "Loony",
          "Description": "Added by Josie Musto on Tuesday 20 May 2025",
          "Caption": "Positions",
          "Icon": "gi gi-playing_dices",
          "Visible": true,
          "CaptionVisible": true,
          "TooltipVisible": true,
          "IconVisible": true,
          "FormVisible": true,
          "VisibleVisible": true,
          "StyleVisible": true,
          "Style": "Themed",
          "Tooltip": "Number of player positions",
          "DataSourceVisible": true,
          "FrequencyVisible": false,
          "DataSourceRequest": {
            "RequestId": "7dab991d-e5b2-1972-e33e-62f632f2f668",
            "Type": "Read"
          }
        },
        "items": []
      }
    ]
  }
]