Live Objects - complete developer guide

Analytics Rule

You can create Analytics Rules that will define :

targeted fleet of devices : all targeted devices in a fleet are assumed to have similar behavior in order to better categorize and highlight outliers.
report email settings : you will be able to set the language and recipients of the report

Deleting an Analytics Rule will delete all associated reports, analyses and statistics. Re-creating a new Analytics Rule will trigger new analyses and will require few weeks to generate a new traffic history.

If you just want not to receive the report, you can simply disable the Analytics Rule instead of deleting it. You will be able to re-enable it later and keep the history of your analyses.

API

You can refer to the swagger documentation to list all available APIs.

Create a new Analytics Rule

POST /api/v1/device-analytics/rules
{
	"name": "...",
	"fleet": {
		"connectors": [...],
		"groupPaths": [...]
	},
	"report": {
		"recipients": {...},
		"language": "..."
	},
	"enabled": ...
}

JSON Params	Description
name	Mandatory. user-defined name for the rule, must be unique and not empty.
fleet	Mandatory. defines the targeted devices of a this AnalyticsRule.
fleet.connectors	Mandatory. analyse only devices with these connectivity. 1 and only 1 connector must be defined.
fleet.groupPath	Optional. analyse only devices that belong to this group.
report	Mandatory. defines the analytics report email parameters.
report.recipients	Mandatory. at least one recipient must be set.
report.language	Mandatory. language of the report : either 'en' or 'fr'.
enabled	Optional. activate or deactivate the rule (default is false).

JSON Params

Description

name

Mandatory. user-defined name for the rule, must be unique and not empty.

fleet

Mandatory. defines the targeted devices of a this AnalyticsRule.

fleet.connectors

Mandatory. analyse only devices with these connectivity. 1 and only 1 connector must be defined.

fleet.groupPath

Optional. analyse only devices that belong to this group.

report

Mandatory. defines the analytics report email parameters.

report.recipients

Mandatory. at least one recipient must be set.

report.language

Mandatory. language of the report : either 'en' or 'fr'.

enabled

Optional. activate or deactivate the rule (default is false).