Live Monitoring API

In addition to Quavo’s internal technical and business monitoring of our client systems, we offer our clients the ability to consume our live monitoring events via our Monitoring API.

These services' results are meant to be consumed once daily, and are extremely useful in determining trends in overall system health over time, as opposed to just-in-time reporting that is offered in standard platform reporting.

Live Monitoring

Usage: The Live Monitoring endpoint will be sufficient for the vast majority of use cases. The purpose of this endpoint is to provide in depth detail of individual Monitoring Records as they currently stand in the system. This is broken out by Record (the type of monitoring item we are reporting on) and Record Detail (the sub-category of this record - used for more in depth debugging/understanding)

Endpoint: https://<environment-name>/prweb/api/Monitoring/v1/Live

Response Format:

{
    "Record": [
        {
            "Value": 17,
            "RecordDetail": [
                {
                    "Value": 14,
                    "Name": "Sent"
                },
                {
                    "Value": 3,
                    "Name": "Transmitted"
                }
            ],
            "Name": "Correspondence Sent"
        },
        {
            "Value": 1,
            "RecordDetail": [
                {
                    "Value": 1,
                    "Name": "No Response Received"
                }
            ],
            "Name": "Recovery Actions Taken"
        },
        {
            "Value": 9,
            "RecordDetail": [
                {
                    "Value": 6,
                    "Name": "ExecuteVisaAcceptDispute"
                },
                {
                    "Value": 2,
                    "Name": "VisaRecallDispute"
                },
                {
                    "Value": 1,
                    "Name": "VisaCaseFilingStatus"
                }
            ],
            "Name": "Visa Failures"
        }
    ]
}

In this example we can observe 2 different Monitoring items returned:

1. Correspondence Sent

   1. Here we can see the total number of correspondences sent from the system today (17)

      1. The number in the “Sent” status for email-based correspondence (14)

      2. The number in “Transmitted” status for mail-based correspondence (3)

2. Recovery Actions Taken

   1. Here we can see the total Recovery Actions submitted for the day (1)

      1. “No Response Received” actions (1)

3. Visa Failures

   1. Within this Record we can review all Visa Failures for the day (9)

      1. “ExecuteVisaAcceptDispute” failures (6)

      2. “VisaRecallDispute” failures (2)

      3. “VisaCaseFilingStatus” failures (1)

As of this writing, there are a number of Monitoring Records that are sent from the Live Monitoring service, including:

Incomplete Accounting: accounting that has been kicked off by a workflow but not yet completed
Unsent Correspondence: correspondence that has been kicked off by a workflow but not yet completed
Auto Accounting: automated accounting actions processed
Recovery Actions Taken: recovery actions taken with all associations
Correspondence Sent: correspondence instances sent by the system to cardholders
MasterCard Failures: failures encountered while submitting to the Mastercom API
Visa Failures: failures encountered while submitting to the Visa API
Amex Failures: failures encountered while submitting to the Amex API
Tracking Only Accounting: automated accounting actions processed
Authorizations Matched*: temporary authorization disputes matched to posted transactions
Merchant Credits Matched*: disputes with a merchant credit matched and processed
Blocked Cards*: cards that have been blocked by the system
Disputed Dollar Amount*: total dollar amount of disputed transactions

*currently in development

Monitoring Record Detail

Usage: To display average data for a given Monitoring Record over time.

Endpoint: https://<environment-name>/prweb/api/Monitoring/v1/RecordDetail/<record-name>

Response Format:

{
    "TotalRecordsYesterday": 7304,
    "ThirtyDayAverage": 6851.53,
    "SevenDayAverage": 7228.29,
    "TotalRecords": 7326
}