Link Search Menu Expand Document

1. Module Time series Metrics

Op name:

scmetrics.getNLatestEventLogs

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": "...",
        "Module": "...",
        "N": ...,
}

Request body parameters

Key Description
Principal (Required) This can be projectid, installation/subzone id or device id
Module (Required) The module name to show events for. For e.g., workorders
N (Required) The number of logs to fetch

More example Requests/Responses:

1. Example Request:

Body:

{
"Principal": "BuildingId1",
    "Module": "sctasks",
    "N": 2
}
1. Example Response: 
{
    "type": "json",
        "queryType": "eventsTSDB",
        "series": {
        "values": [
            {
                "ATTR": "TASK_COMPLETED#PropId1#BuildingId1#uuid2",
                "Description": "John Doe has completed TASK_0002 in Zone 1.",
                "Event": "TASK_COMPLETED",
                "ID": "sctasks",
                "Principal": "BuildingId1",
                "Status": "NORMAL",
                "Time": "1610013130"
            },
            {
                "ATTR": "TASK_COMPLETED#PropId1#BuildingId1#uuid3",
                "Description": "John Doe has completed TASK_0003 in Zone 1.",
                "Event": "TASK_COMPLETED",
                "ID": "sctasks",
                "Principal": "BuildingId1",
                "Status": "NORMAL",
                "Time": "1610013124"
            }
        ],
            "n": 2
    }
}


Table of contents