Rules Statistics

List Rules Overview

User can get the details of the number of rules running, stopped and in created state.

  • GET http://<domain>/MessageRouting/v2.0/overiew

  • Click on GET /overview API in swagger and hit Try it out! button, it wil display all the MR rule count as below:

 {
"Created": 26,
"Started": 2,
"Stopped": 4
 }

The swagger image for get all rule details is as follows:

../../_images/mrStats1.PNG

List Statistics for All Rules

User can get the summary statistics of message processed by rules.

  • GET http://<domain>/MessageRouting/v2.0/statistics?rule_id={rule_id}&start_time={start_time}&end_time={end_time}

  • Click on GET /statistics API in swagger and hit Try it out! button, it wil display the details of message processed by the rule as mentioned below:

{
"MessageCount": 10,
"SuccessCount": 5,
"FailureCount": 5
}

The swagger image to get all statistics is as follows:

../../_images/mrStats2.png

Note

  • If user does not mention the rule ID then API will give the sum of all rules created by the user.

  • If user does not give start time then start time will be considered as rule’s first start time.

  • If user does not give end time then end time will be considered as current time.

  • User can give rule ID in comma separated form to get the sum of multiple rules.

List Statistics for a Rule

User can get the detailed statistics of message processed by a specific rule.

  • GET http://<domain>/MessageRouting/v2.0/statistics/{rule_id}

  • Click on GET /statistics/{rule_id} API in swagger and hit Try it out! button, it wil display the details of messages processed by the rule as below:

 {
"MessageCount": 5,
"SuccessCount": 0,
"FailureCount": 5,
"AvgHourlyMessageRate": 0.014970059880239521
 }

The swagger image for getting a specific rule statistics is as follows:

../../_images/mrStats3.png