Retrieve data model metrics

Available since Strategy ONE (September 2025)

This workflow demonstrates how to retrieve data model metrics and their advanced properties using the REST API, with and without a changeset.

info

Get the authorization token needed to execute the request with POST /api/auth/login.

Get the project ID from GET /api/projects.

tip

Changesets are used in this workflow. For information on how to create and use changesets, see Changesets.

Retrieve a data model metric
Retrieve data model metrics
Retrieve data model metric applicable advanced properties

A detailed description of each step of this workflow is listed below.

Retrieve a data model metric

You can retrieve a specific data model metric.

Endpoint: GET /api/model/dataModels/{dataModelId}/metrics/{metricId}

Sample Request Without Changeset

Request Headers

'Content-Type: application/json'
'Accept: application/json'
'X-MSTR-AuthToken: ie09s7dik3vbv8ga9qkodk9luu'
'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'

Curl

curl -L -X GET 'http://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/3A82F20B2CC849B0970B289C86D8C83C/metrics/D0D7ED4D7CCB4535AA7609B24FE2B7FC' \
-H 'X-MSTR-AuthToken: ie09s7dik3vbv8ga9qkodk9luu' \
-H 'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'

Sample Request With Changeset

Request Headers

'Content-Type: application/json'
'Accept: application/json'
'X-MSTR-AuthToken: ie09s7dik3vbv8ga9qkodk9luu'
'X-MSTR-MS-Changeset: 768A0AA9E94547218BA930DD4245186B'

Curl

curl -L -X GET 'http://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/3A82F20B2CC849B0970B289C86D8C83C/metrics/D0D7ED4D7CCB4535AA7609B24FE2B7FC' \
-H 'X-MSTR-AuthToken: ie09s7dik3vbv8ga9qkodk9luu' \
-H 'X-MSTR-MS-Changeset: 768A0AA9E94547218BA930DD4245186B'

Sample Response

Response Body:

{
  "information": {
    "dateCreated": "2025-08-20T07:40:02.873Z",
    "dateModified": "2025-08-20T07:40:02.873Z",
    "versionId": "0FB11BB44E5EAF9AB7B214AF229CF851",
    "acg": 255,
    "primaryLocale": "en-US",
    "objectId": "D0D7ED4D7CCB4535AA7609B24FE2B7FC",
    "subType": "metric",
    "name": "New Metric",
    "destinationFolderId": "3567B6C7338D4CFFB2F03879C4CB831D"
  },
  "expression": {
    "text": "Count({Call Center}) * 10",
    "inputText": "&count([Call Center])*10",
    "tokenStreamXml": "<tknstrm resf=\"0\"><mi cn=\"8\"><in><oi id=\"1\" did=\"8107C31CDD9911D3B98100C04F2233EA\" ab=\"\" icp=\"\" vr=\"0D9838A7E5404C01813440A99FE34E04\" des=\"Returns the number of values the ValueList. This is a group-value function.\" n=\"Count\" tp=\"11\" stp=\"2816\" acg=\"255\" sta=\"1073873279\" ext_type=\"0\" hid=\"0\"/><oi id=\"2\" did=\"FFA2DF297AAC4EDA9F8DA28A9EC8FBBF\" ab=\"\" icp=\"\" vr=\"6324AEB64689D526B216A08F92B96019\" des=\"Unique identifier for the call center, linking sales data to specific call center operations.\" n=\"Call Center\" tp=\"12\" stp=\"3072\" acg=\"255\" sta=\"4991\" ext_type=\"448\" hid=\"0\"/><oi id=\"3\" did=\"8107C312DD9911D3B98100C04F2233EA\" ab=\"\" icp=\"\" vr=\"9799FF004D45156A6931F6918AF92D09\" des=\"Returns the product of two values.\" n=\"*\" tp=\"11\" stp=\"2816\" acg=\"255\" sta=\"1073873279\" ext_type=\"0\" hid=\"0\"/></in><tkn v=\"&amp;\" tp=\"38\" lv=\"4\" sta=\"2\" sps=\"0\" length=\"1\"/><tkn v=\"count\" tp=\"280\" lv=\"4\" sta=\"2\" sps=\"1\" length=\"5\"><orf><fun rfd=\"1\"/></orf></tkn><tkn v=\"(\" tp=\"40\" lv=\"4\" sta=\"2\" sps=\"6\" length=\"1\"/><tkn v=\"[Call Center]\" tp=\"264\" lv=\"4\" sta=\"2\" sps=\"7\" length=\"13\"><orf><at rfd=\"2\"/></orf></tkn><tkn v=\")\" tp=\"41\" lv=\"4\" sta=\"2\" sps=\"20\" length=\"1\"/><tkn v=\"*\" tp=\"42\" lv=\"4\" sta=\"2\" sps=\"21\" length=\"1\"><orf><fun rfd=\"3\"/></orf></tkn><tkn v=\"10\" tp=\"262\" lv=\"4\" sta=\"2\" sps=\"22\" length=\"2\"/><tkn v=\"\" tp=\"-1\" lv=\"4\" sta=\"2\" sps=\"24\" length=\"0\"/></mi></tknstrm>"
  },
  "metricSubtotals": [
    {
      "definition": {
        "objectId": "96C487AF4D12472A910C1ACACFB56EFB",
        "subType": "system_subtotal",
        "name": "Total"
      }
    },
    {
      "definition": {
        "objectId": "078C50834B484EE29948FA9DD5300ADF",
        "subType": "system_subtotal",
        "name": "Count"
      }
    },
    {
      "definition": {
        "objectId": "B328C60462634223B2387D4ADABEEB53",
        "subType": "system_subtotal",
        "name": "Average"
      }
    },
    {
      "definition": {
        "objectId": "00B7BFFF967F42C4B71A4B53D90FB095",
        "subType": "system_subtotal",
        "name": "Minimum"
      }
    },
    {
      "definition": {
        "objectId": "B1F4AA7DE683441BA559AA6453C5113E",
        "subType": "system_subtotal",
        "name": "Maximum"
      }
    },
    {
      "definition": {
        "objectId": "54E7BFD129514717A92BC44CF1FE5A32",
        "subType": "system_subtotal",
        "name": "Product"
      }
    },
    {
      "definition": {
        "objectId": "83A663067F7E43B2ABF67FD38ECDC7FE",
        "subType": "system_subtotal",
        "name": "Median"
      }
    },
    {
      "definition": {
        "objectId": "36226A4048A546139BE0AF5F24737BA8",
        "subType": "system_subtotal",
        "name": "Mode"
      }
    },
    {
      "definition": {
        "objectId": "7FBA414995194BBAB2CF1BB599209824",
        "subType": "system_subtotal",
        "name": "Standard Deviation"
      }
    },
    {
      "definition": {
        "objectId": "1769DBFCCF2D4392938E40418C6E065E",
        "subType": "system_subtotal",
        "name": "Variance"
      }
    },
    {
      "definition": {
        "objectId": "E1853D5A36C74F59A9F8DEFB3F9527A1",
        "subType": "system_subtotal",
        "name": "Geometric Mean"
      }
    },
    {
      "definition": {
        "objectId": "F225147A4CA0BB97368A5689D9675E73",
        "subType": "system_subtotal",
        "name": "Aggregation"
      }
    }
  ],
  "aggregateFromBase": false,
  "formulaJoinType": "default",
  "smartTotal": "decomposable_true",
  "dataType": {
    "type": "reserved",
    "precision": 0,
    "scale": 0
  },
  "format": {
    "header": [],
    "values": [
      {
        "type": "number_category",
        "value": "0"
      },
      {
        "type": "number_decimal_places",
        "value": "0"
      },
      {
        "type": "number_format",
        "value": "#,##0;(#,##0)"
      }
    ]
  },
  "subtotalFromBase": false,
  "metricFormatType": "reserved",
  "thresholds": [],
  "embeddedObjects": [
    {
      "id": "D5CAE2E2487E529A01E48AB5F8166AAE",
      "subType": "agg_metric",
      "expression": {
        "text": "Count({Call Center})"
      }
    },
    {
      "id": "E7DAE05F445651112F5A538A2090BEE2",
      "subType": "metric",
      "expression": {
        "text": "Count({Call Center})"
      },
      "dimty": {
        "dimtyUnits": [
          {
            "dimtyUnitType": "report_base_level",
            "aggregation": "normal",
            "filtering": "apply",
            "groupBy": true
          }
        ],
        "excludeAttribute": false,
        "allowAddingUnit": true
      },
      "conditionality": {
        "embedMethod": "report_into_metric_filter",
        "removeElements": true
      }
    }
  ],
  "pushDownBehavior": "automatic"
}

Response Code: 200 (Success: OK)