analytics endpoints

Edit online

Use the references for REST API 28.0 analytics endpoints.

GET /analytics/ade_rules
Retrieves a list of ADE rules.
GET /analytics/ade_rules/ade_rule_delete_tasks/{task_id}
Retrieves the delete the ADE rule task status.
GET /analytics/ade_rules/ade_rule_dependent_tasks/{task_id}
Retrieves the dependent the ADE rule task status.
POST /analytics/ade_rules/ade_rule_dependent_tasks/{task_id}
Cancels a dependent the ADE rule task.
GET /analytics/ade_rules/ade_rule_dependent_tasks/{task_id}/results
Retrieves the ADE rule dependent task results.
DELETE /analytics/ade_rules/{id}
Deletes an ADE rule. To ensure safe deletion, a dependency check is carried out. The check might take some time. An asynchronous task is started to do this check.
GET /analytics/ade_rules/{id}
Retrieves an ADE rule.
POST /analytics/ade_rules/{id}
Updates the ADE rule owner or enabled/disabled only.
GET /analytics/ade_rules/{id}/dependents
Retrieves the objects that depend on the ADE rule.
GET /analytics/building_blocks
Retrieves a list of building block rules.
GET /analytics/building_blocks/building_block_delete_tasks/{task_id}
Retrieves the delete the building block rule task status.
GET /analytics/building_blocks/building_block_dependent_tasks/{task_id}
Retrieves the dependent the building block rule task status.
POST /analytics/building_blocks/building_block_dependent_tasks/{task_id}
Cancels the dependent the building block rule task.
GET /analytics/building_blocks/building_block_dependent_tasks/{task_id}/results
Retrieves the building block rule dependent task results.
DELETE /analytics/building_blocks/{id}
Deletes the building block rule. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
GET /analytics/building_blocks/{id}
Retrieves a building block rule.
POST /analytics/building_blocks/{id}
Updates the building block rule owner or enabled/disabled only.
GET /analytics/building_blocks/{id}/dependents
Retrieves the objects that depend on the building block rule.
GET /analytics/custom_actions/actions
Retrieves a list of available custom actions.
POST /analytics/custom_actions/actions
Creates a new custom action with the supplied fields.
DELETE /analytics/custom_actions/actions/{action_id}
Deletes an existing custom action.
GET /analytics/custom_actions/actions/{action_id}
Retrieves a custom action based on the supplied action_id.
POST /analytics/custom_actions/actions/{action_id}
Updates an existing custom action.
GET /analytics/custom_actions/interpreters
Retrieves a list of available custom action interpreters.
GET /analytics/custom_actions/interpreters/{interpreter_id}
Retrieves a custom action interpreter based on supplied interpreter_id.
GET /analytics/custom_actions/scripts
Retrieves a list of meta-data for available custom action script files.
POST /analytics/custom_actions/scripts
Creates a new custom action script file. Newly created custom action script files require a deployment before using.
DELETE /analytics/custom_actions/scripts/{script_id}
Deletes an existing custom action script file.
GET /analytics/custom_actions/scripts/{script_id}
Retrieves meta-data of a custom action script file based on supplied script_id.
POST /analytics/custom_actions/scripts/{script_id}
Updates an existing custom action script file. Updated custom action script files require a deployment before using.
GET /analytics/rule_groups
Retrieves a list of the rule groups.
DELETE /analytics/rule_groups/{group_id}
Deletes a rule. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
GET /analytics/rule_groups/{group_id}
Retrieves a rule group.
POST /analytics/rule_groups/{group_id}
Updates the owner of a rule group.
GET /analytics/rules
Retrieves a list of rules.
DELETE /analytics/rules/{id}
Delete the rule. To ensure safe deletion, a dependency check is carried out. This check might take some time. An asynchronous task to do is started for this check.
GET /analytics/rules/{id}
Retrieves a rule.
POST /analytics/rules/{id}
Updates the rule owner or enabled/disabled only.
GET /analytics/rules/{id}/dependents
Retrieves the objects that depend on the rule.
GET /analytics/rules/rule_delete_tasks/{task_id}
Retrieves the delete the rule task status.
GET /analytics/rules/rule_dependent_tasks/{task_id}
Retrieves the dependent rule task status.
POST /analytics/rules/rule_dependent_tasks/{task_id}
Cancels the dependent the rule task.
GET /analytics/rules/rule_dependent_tasks/{task_id}/results
Retrieves the rule dependent task results.
GET /analytics/rules_offense_contributions
Retrieves Rule Offense contributions Retieves Rule and Offense references in the system.