PrerequisitesΒΆ

  • authToken - The authentication token from Plixer Scrutinizer that allows access to API.

  • rm - The runmode for accessing the API. It is specific to each section of the product. report_api will be used for each of the following examples.

  • action - The list of available actions will change with each request. Below is an action within the report_api run mode:

Field

Description

get

the action used to execute flow reports

  • rpt_json - An array of details to specify most of the options found in the gear menu of the UI, where you can specify report type, date range, etc. See the See Available Parameters section on how to fill out the rpt_json field. Every report has an API tab for obtaining JSON for it.

  • data_requested - Indicates what part of the report is needed. Reports return two data sets, one for rendering the graph and the other for rendering the table. Each one is divided into outbound and inbound. While rpt_json tells Plixer Scrutinizer how to prepare the data (timeframe, filters, aggregation, etc.), data_requested tells Plixer Scrutinizer what data should be returned with the request (inbound, outbound, table, graph, or just a table name).