Asset Metrics

Retrieving Asset Metrics Data By Asset ID

To retrieve a company asset metrics information of a particular asset.

API Reference: /api/entities/asset/metrics/data/byAssetId/{assetId}


HTTP Method	GET
Path	/api/entities/asset/metrics/data/byAssetId/{assetId}
Request parameters	Asset ID: unique ID of the asset

Request Example

curl --request GET \
     --url https://quantiumfundwebapi.azurewebsites.net/api/entities/asset/metrics/data/byAssetId/5d0a336f97d3146bd8fe4bfe

Output definition

The return JSON Response will be an array of multiple Asset Metrics sheets. Each sheet refers to a different metrics period which are Monthly metrics, Quarterly metrics, and Annual metrics.

Within each sheet, the data structure is explained in the below table

Property	Description
periods	A data model describing the period column of the table, the model contain the month, quarter, and year information
metrics	This is the property that stores the content of each metric row.

Output Example

[
  {
    "sheets": [
      {
        "sharedAssetId": "5d0a336f97d3146bd8fe4bfe",
        "periods": [
          {
            "id": "1_2020",
            "title": "1/2020",
            "month": 1,
            "quarter": null,
            "year": 2020
          },
          {
            "id": "2_2020",
            "title": "2/2020",
            "month": 2,
            "quarter": null,
            "year": 2020
          }
        ],
        "metrics": [
          {
            "name": "Revenue",
            "unit": "Currency",
            "1_2020": 100000,
            "2_2020": 100000,
            "3_2020": 100000
          },
          {
            "name": "Revenue % growth yoy",
            "unit": "Percentage",
            "excluded": null,
            "1_2020": 0.5,
            "2_2020": 0.5,
            "3_2020": 0.5
          }
        ],
        "folderId": "5f11c087c2b7812accc092a8",
        "sheetId": 1,
        "sheetName": "Monthly metrics",
        "periodType": "Monthly",
        "comment": null,
        "isCurrentSheet": true,
        "isDefaultSheet": true,
        "internalId": "5f4c7c8f930194435897779c"
      },
      {
        "sharedAssetId": "5d0a336f97d3146bd8fe4bfe",
        "periods": [
          {
            "id": "1_2018",
            "title": "Q1 2018",
            "month": null,
            "quarter": 1,
            "year": 2018
          },
          {
            "id": "2_2018",
            "title": "Q2 2018",
            "month": null,
            "quarter": 2,
            "year": 2018
          }
        ],
        "metrics": [
          {
            "name": "Revenue",
            "unit": "Currency",
            "1_2018": 50000,
            "2_2018": 50000
          }
        ],
        "folderId": "5f11c087c2b7812accc092a8",
        "sheetId": 2,
        "sheetName": "Quarterly metrics",
        "periodType": "Quarterly",
        "isCurrentSheet": true,
        "isDefaultSheet": true,
        "internalId": "61d6ecd37377e2eef1e3b129"
      },
      {
        "sharedAssetId": "5d0a336f97d3146bd8fe4bfe",
        "periods": [
          {
            "id": "2016",
            "title": "2016",
            "month": null,
            "quarter": null,
            "year": 2016
          },
          {
            "id": "2017",
            "title": "2017",
            "month": null,
            "quarter": null,
            "year": 2017
          }
        ],
        "metrics": [
          {
            "2016": 500000,
            "2017": 500000,
            "name": "Revenue",
            "unit": "Currency"
          }
        ],
        "folderId": "5f11c087c2b7812accc092a8",
        "sheetId": 3,
        "sheetName": "Annual metrics",
        "periodType": "Annual",
        "isCurrentSheet": true,
        "isDefaultSheet": true,
        "internalId": "61d6ece07377e2eef1e3b12e"
      }
    ]
  }
]

Retrieving Asset metrics By Folder

Asset metrics can be organized into different subfolders. "Income statement", "Balance sheet", "Operating metrics" are the folder names that are automatically generated for all the assets.
Within each folder, there can be multiple metrics sheets, which are Monthly metrics, Quarterly metrics, and Annual metrics. In case there are asset metrics information stored in multiple sub folder, you can specify the folder ID in order to narrow down the result using the following API


HTTP Method	GET
API Endpoint	/api/entities/asset/metrics/data/byfolderId/{metricsFolderId}
Request parameter	metricsFolderID : An ID of the specific asset metrics folder. You can see the list of all the folders of each asset using a folder list API /api/entities/asset/metrics/folder/list/{assetInternalId}