Link Search Menu Expand Document

1. Module Metrics

Op name:

scmetrics.getModuleMetricsBatchPrincipals

Endpoint:

Method: POST
Type: application/json
URL: /v1/actions

Headers:

Key Value Description
Authorization   (Required) The Access Token or HMAC Signature
x-sc-identity external (Required)

Body:

{
        "Principal": [...],
        "NS": "..."
}

Request body parameters

Key Description
Principal (Required) This can be projectid, installation/subzone id or device id
NS (Required) Namespace to query. For e.g., BUILDING_METRICS.

More example Requests/Responses:

1. Example Request:

Body:

{
    "Principal": ["...", "..."],
    "NS": "BUILDING_METRICS"
}
1. Example Response:
{
    "type": "json",
        "queryType": "module",
        "metrics": [
        {
            "data": {
                "LevelsCount": 2,
                "TotalArea": 20,
                "ZonesCount": 7
            },
            "principal": "8865fc0a55604b6d8f96bdb4022fec00"
        },
        {
            "data": {
                "TotalArea": 21000
            },
            "principal": "9865fc0a55604b6d8f96bdb4022fec00"
        }
    ]
}



Table of contents