reportDefinition

Namespace:	(default namespace)
XML Schema:	api.xsd

Report definitions are defined primarily by a ReportDefinition object. There are also many sub-types of ReportDefininition which all of the report APIs also accept:

AdHocDefinition: Reports on any data of any object type.
DeviationDefinition: Reports which objects' data deviate from their observed mean values.
HealthDefinition: Reports Identifies which objects have exceeded specific thresholds, such as interface utilization, or LSP setup bandwidth.
LagImbalanceDefinition: A specific type of health report focusing on link aggregate groups (LAGs.)
TrendingDefinition: Also known as a Traffic report, this report projects traffic trends over a period of time.

To construct a report definition object, use all of the attributes defined for ReportDefinition, plus a set of attributes from one of the above sub-types. The following example shows an instance of an AdHocDefinition, which reports on interface traffic and utilization numbers for the past month, grouped by capacity. It includes all of the elements of a AdHocDefinition plus all elements of a ReportDefinition.

JSON Example


{
 "properties": [
  {
    "name": "Capacity",
    "aggregationMode": "P95",
    "groupBy": null,
    "growthAggMode": null,
    "growthAggPeriodDateValue": 0,
    "growthAggPeriodDateUnits": null,
    "growthAlgoTypes": null
  },
  {
    "name": "TraffIn",
    "aggregationMode": "P95",
    "groupBy": null,
    "growthAggMode": null,
    "growthAggPeriodDateValue": 0,
    "growthAggPeriodDateUnits": null,
    "growthAlgoTypes": null
  },
  {
    "name": "TraffOut",
    "aggregationMode": "P95",
    "groupBy": null,
    "growthAggMode": null,
    "growthAggPeriodDateValue": 0,
    "growthAggPeriodDateUnits": null,
    "growthAlgoTypes": null
  },
  {
    "name": "UtilIn",
    "aggregationMode": "P95",
    "groupBy": null,
    "growthAggMode": null,
    "growthAggPeriodDateValue": 0,
    "growthAggPeriodDateUnits": null,
    "growthAlgoTypes": null
  },
  {
    "name": "UtilOut",
    "aggregationMode": "P95",
    "groupBy": null,
    "growthAggMode": null,
    "growthAggPeriodDateValue": 0,
    "growthAggPeriodDateUnits": null,
    "growthAlgoTypes": null
  }
 ],
 "aggPeriodUnits": "day",
 "aggPeriodValue": 1,
 "hasRawData": false,
 "definitionId": 69,
 "network": networkA,
 "name": "Monthly Utilization",
 "owner": "admin",
 "reportType": "AdHoc",
 "objectType": "Interfaces",
 "group": "Capacity",
 "subGroup": "IsNotNull",
 "query": null,
 "filter": null,
 "outputFilter": null,
 "outputSorts": null,
 "objectKeys": null,
 "timeRangeUnits": "month",
 "timeRangeValue": 1,
 "timeFrom": null,
 "timeTo": null,
 "hasCumulativeSum": true,
 "aggregateAfterGroupBy": false,
 "cumulativeGroupBy": "Capacity",
 "isMyReport": false,
 "isLive": false
}

JSON

property	type	description
network	network (string)	Name of the network
name	name (string)	Name of the report. Examples: 3 Months Utilization Report
owner	owner (string)	Owner of the report.
reportType	reportType (string)	Report type. Examples: AdHoc, Deviation, Health, LagImbalance or Trending.
definitionId	definitionId (long)	Unique report definition id. The system will assign a unique id if not defined.
objectType	objectType (string)	Object type to define the type of objects you are running report upon. Examples: Interfaces, Nodes, or LSPs
group	group (string)	Name of the attribute to filter on. Examples: Capacity, AS, Operational Status
subGroup	subGroup (string)	Value of the attribute to filter with. Examples: 10000 for Capacity, 60002 for AS, Up for Operational Status,
query	query (string)	Query statement to select the criteria to report on. Examples:
outputFilter	outputFilter (string)	Filter to report the outputs. Examples: Capacity>20000 on an interface report will show only interfaces with capacity more than 20000
outputSorts	outputSorts (string)	Sorting criteria for the output of the report. Examples: Capacity, AS
filter	filter (string)	Definition of a filter to select objects to report on. Examples: Capacity > 2000
exclude	exclude (boolean)	Definition of a specific object such as an interface or a node. Examples: {name: node, value:SJC-1}, {name: name, value: xe0/0/0.1} for an interface
objectKeys	array of objectKeys (objectKey)	Definition of a specific object such as an interface or a node. Examples: {name: node, value:SJC-1}, {name: name, value: xe0/0/0.1} for an interface
timeRangeUnits	timeRangeUnits (string)	Unit of the time period of historic data used in the report. Examples: day, month, or year
timeRangeValue	timeRangeValue (int)	Value of the time period of historic data used in the report. Examples: 3 with timeRangeUnits of month means we use the last 3 months of data
timeFrom	timeFrom (string)	Date and time of the starting time for the time period of the historic data used in the report. Examples: 2011-08-15 08:00:00
timeWindowTo	timeWindowTo (string)	Time window of the starting time for the time period of the historic data used in the report. Examples: 08:00:00
timeWindowFrom	timeWindowFrom (string)	Time window of the ending time for the time period of the historic data used in the report. Examples: 08:00:00
timeTo	timeTo (string)	Date and time of the starting time for the time period of the historic data used in the report. Examples: 2011-10-15 08:00:00
hasCumulativeSum	hasCumulativeSum (boolean)	Boolean value to define whether the report is on aggregated values. Examples: True combined with CumulativeGroupBy AS to report an aggregated values of the same AS.
aggregateFirst	aggregateFirst (boolean)	Boolean value to define whether to aggregate values first before grouping Examples: False preserves the default behavior of calculating aggregate values after performing any groupings.
isMyReport	isMyReport (boolean)	Boolean value to indicate whether the report is the current logged in user's. Examples: True means the report belongs to this user.
isLive	isLive (boolean)	Boolean value to define whether the report is temporary and will not be persisted
totalRecords	totalRecords (int)	Attribute to define how to group the objects and report the aggregated values. Examples: sourceNode on interfaces report will report aggregated values on all interfaces with the same source node.
cumulativeGroupBy	cumulativeGroupBy (string)	Attribute to define how to group the objects and report the aggregated values. Examples: sourceNode on interfaces report will report aggregated values on all interfaces with the same source node.