Dashboard

Dashboard - DashboardData

API to fetch Logpoint dashboard data.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Dashboard/data

Parameter

Field

Label in UI

Type

Description

search_id

String

A unique identifier to fetch dashboard data. Mandatory Field

Request Example

{
    "data": {
        "search_id": "life_c5448e0xxxxxxxxxxxxb9d49"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}/{data_node}-Logs/fetchLogData"
}

API Response

{
    "request": {},
    "logpoint_identifier": "45b2c5xxxxxxxxxxxxxxf0e610e",
    "pool_uuid": "3db59e1fxxxxxxxxxxx56f65b",
    "response": {
        "success": true,
        "rows": [
            {
                "msg": "2025-08-28 10:22:51 Benchmarker; reporting speed; service=normalizer_0; actual_mps=0; doable_mps=2326;",
                "log_ts": 1756376571,
                "actual_mps": "0",
                "doable_mps": "2326",
                "_type_str": "msg col_type device_name collected_at device_ip source_name _tz _enrich_policy device_address label norm_id action object service _fromV550 repo_name logpoint_name",
                "device_name": "localhost",
                "_offset": 98948,
                "logpoint_name": "LogPoint201",
                "action": "reporting speed",
                "device_address": "12x.xx.1",
                "repo_name": "_logpoint",
                "source_name": "/opt/immune/var/log/benchmarker/normalizer_0.log",
                "col_ts": 175xxxx1,
                "_tz": "UTC",
                "norm_id": "LogPoint",
                "_identifier": "0",
                "collected_at": "LogPoint201",
                "device_ip": "12xxx.1",
                "service": "normalizer_0",
                "_fromV550": "t",
                "_enrich_policy": "None",
                "index_ts": 17xxxxx1,
                "_type_num": "log_ts col_ts actual_mps doable_mps sig_id _offset _identifier",
                "_type_ip": "device_ip",
                "sig_id": "10505",
                "col_type": "filesystem",
                "object": "Benchmarker",
                "_labels": [
                    "LogPoint",
                    "Benchmarker"
                ]
            },
            {
                "msg": "2025-08-28 10:22:51 Benchmarker; reporting speed; service=norm_front; actual_mps=1; doable_mps=49604;",
                "log_ts": 17xxxxx571,
                "actual_mps": "1",
                "doable_mps": "49604",
                "_type_str": "msg col_type device_name collected_at device_ip source_name _tz _enrich_policy device_address label norm_id action object service _fromV550 repo_name logpoint_name",
                "device_name": "localhost",
                "_offset": 99167,
                "logpoint_name": "LogPoint201",
                "action": "reporting speed",
                "device_address": "12x.xx.1",
                "repo_name": "_logpoint",
                "source_name": "/opt/immune/var/log/benchmarker/norm_front.log",
                "col_ts": 1xxxxx1,
                "_tz": "UTC",
                "norm_id": "LogPoint",
                "_identifier": "0",
                "collected_at": "LogPoint201",
                "device_ip": "12x.xxx.1",
                "service": "norm_front",
                "_fromV550": "t",
                "_enrich_policy": "None",
                "index_ts": 17xxxx1,
                "_type_num": "log_ts col_ts actual_mps doable_mps sig_id _offset _identifier",
                "_type_ip": "device_ip",
                "sig_id": "10505",
                "col_type": "filesystem",
                "object": "Benchmarker",
                "_labels": [
                    "LogPoint",
                    "Benchmarker"
                ]
            },
            {
                "msg": "2025-08-28 10:22:51 Benchmarker; reporting speed; service=normalizer_2; actual_mps=0; doable_mps=2263;",
                "log_ts": 17xxxxxx1,
                "actual_mps": "0",
                "doable_mps": "2263",
                "_type_str": "msg col_type device_name collected_at device_ip source_name _tz _enrich_policy device_address label norm_id action object service _fromV550 repo_name logpoint_name",
                "device_name": "localhost",
                "_offset": 99383,
                "logpoint_name": "LogPoint201",
                "action": "reporting speed",
                "device_address": "12x.xx.1",
                "repo_name": "_logpoint",
                "source_name": "/opt/immune/var/log/benchmarker/normalizer_2.log",
                "col_ts": 1xxxxx571,
                "_tz": "UTC",
                "norm_id": "LogPoint",
                "_identifier": "0",
                "collected_at": "LogPoint201",
                "device_ip": "12x.xx.1",
                "service": "normalizer_2",
                "_fromV550": "t",
                "_enrich_policy": "None",
                "index_ts": 175xxxxx71,
                "_type_num": "log_ts col_ts actual_mps doable_mps sig_id _offset _identifier",
                "_type_ip": "device_ip",
                "sig_id": "10505",
                "col_type": "filesystem",
                "object": "Benchmarker",
                "_labels": [
                    "LogPoint",
                    "Benchmarker"
                ]
            }
        ]
    }
}

Dashboard - ListDashboard

API to list all the Logpoint dashboard data.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/Dashboard/list

Request Example

{
    "data": {}
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

API Response

{
    "request": {},
    "logpoint_identifier": "45bxxxxxxxxxxxxe610e",
    "pool_uuid": "3dbxxxxxxxxxxx6f65b",
    "response": {
        "success": true,
        "rows": [
            {
                "tab_id": "6601xxxxxxxxxxdbd28",
                "title": "Quick Start",
                "shareable": true,
                "editable": true,
                "widgets": []
            },
            {
                "tab_id": "68aeaxxxxxxxxxxd86",
                "title": "test_rrm",
                "shareable": true,
                "editable": true,
                "widgets": [
                    {
                        "widget_id": "68aexxxxxxxxxe9d89",
                        "title": "localhost",
                        "x": 0,
                        "y": 0,
                        "height": 200,
                        "width": 300,
                        "life_id": "life_088f36fxxxxxxxxxx290b6",
                        "settings": {
                            "liveSearch": {
                                "searchname": "localhost",
                                "description": "",
                                "query": "device_name=localhost",
                                "extra_query_filter": "",
                                "repos": [
                                    "12x.xxx:5504"
                                ],
                                "query_info": {
                                    "fieldsToExtract": [
                                        "device_name"
                                    ],
                                    "aliases": [],
                                    "success": true,
                                    "query_filter": "device_name=localhost",
                                    "columns": [],
                                    "query_type": "simple",
                                    "lucene_query": "device_name:localhost",
                                    "grouping": []
                                },
                                "timerange_day": 0,
                                "timerange_hour": 0,
                                "timerange_minute": 10,
                                "timerange_second": 0,
                                "limit": 100,
                                "tid": "",
                                "sharing_policy": "private",
                                "generated_by": "dashboard",
                                "vid": "",
                                "flush_on_trigger": false,
                                "exposed": false
                            },
                            "type": "table",
                            "interval": 30
                        },
                        "editable": true
                    }
                ]
            }
        ],
        "message": ""
    }
}

Helpful?

We are glad this guide helped.


Please don't include any personal information in your comment

Contact Support