API Docs

Message metrics

Some high level metrics are available to monitor messaging throughput.

In the UI, metrics can be found by going to Admin > Integrations. Under the Audit Messaging tab, you'll be able to see the current number of queued messages, the number of messages sent over a given timeframe, and the current message delay between when the action was taken and when the message was sent.

Further, each of these metrics can be queried from the API using the following calls:

Gets counts of audit events yet to have messages sent out

GET https://ris.rightsline.com/v4/messages-queued

This endpoint will return count of audit events (grouped by the entity type - charTypeId) that are queued up to be sent out as messages.

Headers

Name
Type
Description

x-api-key*

String

Your company's API key.

Authorization*

String

Authentication token

{
    "queuedMessagesByCharType": [
        {
            "charTypeId": 0,
            "count": 9999
        },
        {
            "charTypeId": 1,
            "count": 8888
        },
        {
            "charTypeId": 3,
            "count": 7777
        }
    ]
}

Get the number of messages sent over a time period

POST https://ris.rightsline.com/v4/messages-sent

Specify a startDate and endDate that must be within the past month. Response will be a count of the messages that were sent out during that time frame.

Headers

Name
Type
Description

x-api-key*

String

Your company's API key.

Authorization*

String

Authentication token

Request Body

Name
Type
Description

startDate

DateTime

Start of the time frame to query messages sent. Must be within past 30 days.

endDate

DateTime

End of the time frame to query messages sent. Must be less than 30 days from the startDate.

9999

Get an average delay (in seconds) for the messages sent during the time frame

POST https://ris.rightsline.com/v4/message-delay

Specify a startDate and endDate that must be within the past month. Response will be the average time between when an event occurred to when the message(s) for that event were sent out.

Headers

Name
Type
Description

x-api-key*

String

Your company's API key.

Authorization*

String

Authentication token

Request Body

Name
Type
Description

startDate

DateTime

Start of the time frame to query messages sent. Must be within past 30 days. Expected in ISO format and UTC time zone (e.g. "2023-09-09T12:00:00")

endDate

DateTime

End of the time frame to query messages sent. Must be less than 30 days from the startDate. Expected in ISO format and UTC time zone (e.g. "2023-09-09T12:00:00")

1234.5

PreviousSample projectsNextFAQ

Last updated