Available parameters¶

rpt_json: This field tells Plixer Scrutinizer how to prepare the data: report type, timeframe, filters, aggregation, etc.

Expected JSON object:

{
  "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"
  }
}

The example above shows the minimum needed option for each field. The following table is a breakdown of the available options for each of the fields from above:

reportTypeLang¶

A language keycode that represents a report type

Report Lang	Report Description
conversations	Conversations WKP (the default report)
host2host	Host to Host
ipGroupGroup	IP Group to IP Group
applications	Applications defined
country2country	Country to Country
..etc..	Each report has an API tab, with the report lang, in the UI

filters¶

sdfDips_0	The exporter and interface to use to generate report with. The syntax for this field is in_[IP Hex]_[interface(s)].
	Value	Description
	in_0A190101_ALL	Uses all interfaces
	in_0A190101_0A190101_1	Uses interface index 1

reportDirections¶

selected	Specifies which direction to query, relative to the interfaces in the filter. If not applicable, use inbound.
	Value
	inbound
	outbound

times¶

Specifies the dateRange in the report

dateRange	Indicates the timeframe to include in the report
	Value
	LastFiveMinutes
	LastTenMinutes
	LastFifteenMinutes
	LastTwentyMinutes
	LastThirtyMinutes
	LastFortyfiveMinutes
	LastHour
	LastFullHour
	LastThreeDays
	LastSevenDays
	LastThirtyDays
	Today
	Yesterday
	Last24Hours
	ThisWeek
	LastWeek
	ThisMonth
	LastMonth
	ThisYear
	LastYear
	Custom
start	Start date of the data to include in the report. Use Custom in the dateRange field to set the start date.
end	End date of the data to include in the report. Use Custom in the dateRange field to set the end date.
clientTimezone	Displays dates local to your time zone
	Value
	America/New_York
	America/Los_Angeles

dataMode¶

Saves and rolls up data to condense collected information

selected	Indicates the timeframe to include in the report
	Value	Description
	saf	Default dataMode type
	traditional	Used for legacy support

rateTotal¶

Specifies whether to display data as a rate or as total traffic

selected	Value	Description
	rate	Displays row data as a rate. For example, packets per second or bits per second
	total	Displays row data as total traffic. For example, total traffic seen within the timeframe

dataGranularity¶

Specifies how to retrieve data for the report

selected	Value	Description
	auto	Lets the API select the data aggregation method
	1m	Displays row data as total traffic. For example, total traffic seen within the timeframe
	5m	Shows data from 1-minute granularity
	30m	Shows data from 5-minute granularity
	2h	Shows data from 2-hour granularity
	12h	Shows data from 12-hour granularity

bbp¶

Determines how to display the data

selected	Value	Description
	bits	Displays data as bits per second or total bits, depending on the rateTotal selection
	bytes	Displays data as bytes per second or total bytes, depending on the rateTotal selection
	percent	Displays data as a percentage, rateTotal selection is disregarded

data_requested: This field tells Plixer Scrutinizer how to prepare the data for graphs, table pagination, etc.

Important

The direction specified in data_requested must match the reportDirections selected value in rpt_json (e.g. inbound/inbound or outbound/outbound).

Expected JSON object expected:

{
   "inbound": {
       "graph": "none",
       "table": {
           "query_limit": {
               "offset": 0,
               "max_num_rows": 10
           }
       }
   }
}

The example above shows the minimum needed option for each field.