The alarms of the API insights can be accessed through the menu item ALARMS, and can be used to report in basically any metric available from the APIs Insights reports. It is a really powerful tool, which make it possible to build your alarms in a completely customized way, based on what your day to day work is centered around.
When should I use API Insights alarms and when should I use HB Alarms?
Well it is dependent on what you want to cover really, as some of the metrics are specific for the different reporting types, but also (in the case of overlap), how fast you need your trigger to happen. It also depends on if you are utilizing both modules or only the API Insights one.
The data in API Insights are imported on a daily level, because some data is simply not complete/consolidated enough to base any proper analysis on. So any alarms built on the PAI data, will naturally also have one day delay. Now this is not critical at all when monitoring some levels, and it certainly provide good stable data over time, and more long-term alarms options; but for more technical alarms the HB Analytics alarms is to be preferred, as they trigger within the hour.
How do I set up a API Insights Alarm?
Start by clicking the "ALARMS" menu item, and then open up the "Alarms" drop down for active alarms:
Here you can see and manage the existing alarms. In order to set up a new alarm, you can press the NEW API INSIGHTS ALARM button. You now have the option to start a "Custom alarm" set up, or select one of the presets. In this guide we will focus on the custom report, as it covers the most options.
This will bring you to a screen that resembles the normal reporting screen. Setting up an alarm is actually very similar to how you pull a report, but there are a few unique things to think about:
- First you give your alarm a name, if you share your alarm, this will also be the name other users will see.
- The dates works differently, so usually it is more about selecting a dynamic time-period in the date-range; like "Per Month" - then the report will trigger on events that take a full month into consideration (or several, if you work with trend metrics)
- Select what you would like to report on. Please notice that if you want to measure fx, "Revenue levels on websites" and want to have a real value; then you should probably work with multiple alarms - one per website (if the trigger level should be different per website). You should then filter on the website you wat to use. If you prefer using % then trend metrics should be used.
- Both normal and trend metrics can be used, but please notice that for normal metrics, real values need to be added, but for trend metrics % can be used. Once done press OK.
- Now you will see a report created based on your settings, and the values that are present for your selection. In the right side of the configuration you can now see an "ALARM" button. Press the alarm button, and you are presented with a Condition for your alarm trigger. Set a condition, fx "Less than" and then select a value, fx 1000 Euro. Press OK.
- You can now SAVE your alarms, and/or select if your alarm should be Private or viewable for others in your organization. Press SAVE when you feel happy with your alarms (you can go back and edit later if you want to).
- Once saved, the new Alarm will show up in the list, with any potential triggers triggered (Errors). These errors can be acknowledged, for the current period if needed (as you are aware of them).
In the top-panel Alarms (collapsed by default) you'll see the Alarms created while the lower (main) part is the individual failures (and/or recoveries) of the alarms. That's what called checks. So one alarm can cause multiple check to fail, for example if there are 2 websites with too low revenues.
If there are multiple conditions AND-logic will be used between them - so that you for example can setup a "low-CPM" alarm but only trigger it when the number of ad-requests is above a certain threshold. It's not possible with OR-conditions as it's probably more intuitive to create different alarms instead - for example create one Low revenue alarm + one High timeout % alarm instead of one Low revenue or high timeout %" alarm.
The Filter failures switch is useful in order to only see the failed (red) lines in the report.
For compare to metrics the logic is a bit different as seen below:
There are a couple of differences for the alarm-reports compared to the normal reports:
- Forecasting can't be selected.
- All dates - Start, End and Compare to - are automatically converted to relative dates when saving as we don't want alarms that checks the same time ranges all the time.
As default, the report alarms won't run if there is an unacknowledged import error - as there's a big chance that a lot of such alarms will trigger as a consequence of the failed imports!
Description of Alarms panel
- Active - That the alarm is active means that it will run automatically, either after imports for programmatic alarms or by a time-schedule for HBA alarms. It's still possible to run the inactive alarms from this page manually.
- Private - If set the alarm is "private" and only visible for the current user.
- Acknowledged/Errors - How many checks that are currently acknowledged/in total generated by the alarm.
- Check run - When manually running alarms here this column will update with "ok check-marks" or error-balloons there was an error running the alarm (not the same thing as if failures was generated by the alarm).
- Actions - Corresponds to the Action-buttons in the top of the list (used for "bulk-actions"). It also contains the Edit button (see later).
Description of checks panel
- Info - Description of the failed object. For example "blurredpublisher.com >> Rubicon" in the screenshot above means that we've created a report-alarm with dimensions Publisher and SSP and in this case the report-line for that Publisher/SSP has failed the alarm condition.
- Alarm - Name of the alarm
- Status - Shows if the alarm is failed and not acknowledged (red balloon), failed and acknowledged (orange) or recovered (green).
- Check run - Same as Check run for the alarms.
- Date - Date of last check, clicking the link will show a popup with "recent history" of the check. This will include times where the status have changed between failed/recovered along with the latest check.
- Actions - Corresponds to the Action-buttons in the top of the list (used for "bulk-actions"). It also contains the View report buttons that will show a report with the same settings that was used when doing the check. The report itself is not saved, just the settings, so it's not certain the check is in the same state when viewing it.
- Generic settings >> Edit global alarm recipients - Mail address(es) to recipients of the global (non-private) alarms.
- Generic settings >> Edit my alarm recipients - Mail address(es) to the current user's private alarms.
- Show checks >> Unacknowledged - Show unacknowledged errors
- Show checks >> Acknowledged - Show acknowledged checks
- Show checks >> Recently recovered - Show that have recovered the last 7 days.