Breadcrumbs

2.2.11 Metrics Catalogue

Purpose

Query to obtain list of metrices.

Endpoint

GET

/data-service/v2/lists/types/{app}?product={product}

Parameters

  • app (string, required):
    Type of application within the product. Please refer to the table below for the complete supported options.

  • product (string, required):
    Type of product offered. Supported products include: pi, pe.

 

Support matrix for “product” and “app”:

Product

App

pi - Private Infrastructure

  • market-indices - Market indices

  • ticcs-benchmarks - TICCS Benchmarks

  • deal-and-valuation-analytics - Deal & Valuation Analytics

Example: types/market-indices?product=pi

pe - Private Equity

  • market-indices - Market Indices

  • peccs-benchmarks - PECCS Benchmarks

Example: types/peccs-benchmarks?product=pe

 

Example

  • Request (URL)

    /data-service/v2/lists/types/market-indices?product=pi

  • Response

    JSON
    {
    "data": {
        "results": [
            {
                "typeId": 60000004,
                "description": "Index level reflecting the total returns compounded since inception",
                "displayName": "Index Price",
                "name": "indexPrice",
                "timeseries": 1,
                "type": "Booty",
                "debtOrEquity": "*",
                "referenceUrl": "https://docs.edhecinfra.com/docs/equity-total-return-index",
                "externalTicker": "T01414"
            },
            ....
        ]
    },
    "metaData": [
        {
            "dataCount": 35
        }
    ]
}