Summaries
Summaries tie together your triggers with the events they generate in Canary. When you create a new Summary, you'll select at trigger, a time period, and the specific data stream monitored by that trigger; Canary then lists all the events generated in that given time frame when your payments data changed enough to trip that trigger.
Summaries Page
To view and manage all your existing summaries, click Summaries in the main navigation. By default, the page displays all of your summaries in a grid of cards; each card identifies the summary’s name, the metric it monitors, and the date range of the summary. Click on a card to view the Summary’s details or click Create New Summary to build out a new summary.
Creating Summaries
To create a new Summary in Canary:
- Open the Canary Service Panel, then click Summaries in the main navigation.
- Click Create New Summary.
- Enter a Summary Name.
- Select a Trigger from the drop-down menu.
- Click the Date Range field to select set a custom date range or select from the default options (Today, Last 7 days, or Month to date).
- Select a Data Stream based on the selected trigger's configuration.
- Click Save.
Summary Data Streams
To configure a Summary in Canary, you must select 1-2 data streams from the potentially numerous data streams monitored by the selected trigger. Data streams are created and identified by the filter options and filter parameters assigned to the trigger.
For example, consider a situation in which you create a trigger monitoring for when your authorization rate drops below 80%. For this trigger, you apply the Card Brand filter with the following parameters checked: Amex, Visa, and Mastercard. In doing so, you're telling Canary to monitor authorization rates for three different data streams (i.e. all transactions made with Amex, Visa, and Mastercard payment cards separately). If you later create a Summary for that trigger, you'll need to select which card brand data streams you want to view event data for.
Managing Summary Details
Click a summary card on the Summaries page to view that summary’s details, including:
- The Trigger that summary is built around
- The metric monitored by the chosen trigger
- The selected Data Stream
- The Date Range covered by the summary
A line graph named for the monitored metric demonstrates how that metric changed for the chosen data stream throughout the summary’s date range. Any point on the graph representing a value that tripped the trigger and created an event will appear as a data point. Below the graph, you’ll find an inbox-style table of those events; click on an event to view additional context and details.
You can take the following actions on this page:
- Click the name of the Trigger to view the details page for the trigger selected in your summary.
- Click Edit Summary to change the settings selected when you created the summary.
- Click Delete Summary to permanently delete the summary from your Canary Service Panel.
Updated 4 months ago