Running Reports

The following example is an API call to run a default report, over the last 5 minutes, on all interfaces of a device.

Note

In the example below, you must replace {{scrutinizer_ip_address}} with your Plixer Scrutinizer’s IP address, as well as {{authToken}} with an Authentication Token that can be obtained from the UI.

Example API call:

curl --location --request POST 'https://{{scrutinizer_ip_address}}/fcgi/scrut_fcgi.fcgi' \
--header 'Content-Type: application/json' \
--form 'authToken={{authToken}}' \
--form 'rm=report_api' \
--form 'action=get' \
--form 'rpt_json=
{
    "reportTypeLang": "conversations",
    "filters": {
        "sdfDips_0": "in_0A190101_ALL"
    },
    "reportDirections": {
        "selected": "inbound"
    },
    "times": {
        "dateRange": "LastFiveMinutes",
        "clientTimezone": "America/New_York"
    },
    "dataMode": {
        "selected": "saf"
    },
    "rateTotal": {
        "selected": "total"
    },
    "dataGranularity": {
        "selected": "auto"
    },
    "bbp": {
        "selected": "bits"
    }

}' \
--form 'data_requested=
{
    "inbound": {
        "graph": "none",
        "table": {
            "query_limit": {
                "offset": 0,
                "max_num_rows": 10
            }
        }
    }
}'

The API call above is processed by the reporting engine, and then the server returns a JSON response.

JSON object returned:

{
    "report": {
        "request_id": "0xed184820e4b611eab58f1fc02130f7f9",
        "table": {
            "inbound": {
                "totalRowCount": 1,
                "footer": [],
                "columns": [],
                "rows": []
            }
        },
        "time_details": {},
        "exporter_details": {},
        "graph": {}
    }
}

The sample response above is condensed to show the typical structure of a JSON response. The following table is a breakdown of the most important fields from the report field/key from the above response: