Link Search Menu Expand Document

1. Module Metrics

Op name:

scmetrics.getModuleMetrics

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": "8865fc0a55604b6d8f96bdb4022fec00",
    "NS": "BUILDING_METRICS"
}
1. Example Response:
{
"id": "total_people_count_by_location_by_hour_for_dom_v2",
    "params": [
    {
        "key": "$month",
        "value": "default"
    },
    {
        "key": "$dom",
        "value": "default"
    },
    {
        "key": "$hour",
        "value": "default"
    },
    {
        "key": "expid",
        "value": "randomexpid"
    }
],
    "qcontext": "scglobal",
    "qtype": "ml"
}



Table of contents