Consumption reports

Consumption graphs and reports let you monitor your usage.

In the Consumption reports view, you can:

• View graphs made with the “New events” calculation method.
• View graphs made with the “Retention events” calculation method.
• Download a detailed XLSX report with results of both methods.

Calculation methods

Synerise offers two modes of event calculation for consumption metrics:

• New events - events that are added to the database every day.
• Retention events - the average number of events already saved in the database every day. The events are stored in the database according to their retention period, which differs between event types and may differ between workspaces.

In both methods, UTC time is used to determine what day an event belongs to.

New events

The “New events” chart counts each event that is processed by Synerise, including events generated automatically by the SDKs and backend.

Events are counted according to the time they were added to the database.
For example, if an item was sold at an offline cash register on September 30 and the transaction.charge event was imported to Synerise on October 1 when the cash register came online, the event is counted towards October.

Retention events

The “Retention events” chart counts the average daily number of events stored in the database, including events generated automatically by the SDKs and backend.

The events are counted in the following way:

1. Every day at midnight (UTC), Synerise checks the number of events in the database.
   This may include events from earlier months, according to their retention period.
   Events overwritten with eventSalt are treated as one event, unless the original event was already deleted due to retention.
2. The number of events is added to the monthly total.
3. At the end of the month, the monthly total is divided by the number of days in the month.
   The result is the average daily number of events in the database.

The Consumption report shows the retention of each event, in days. -1 means the events are stored infinitely.

Graphs

You can view event consumption as a graph, which can be filtered by event type, date, and workspace.

1. Sign in to Synerise.

2. Enter an organization.
   If you can’t see any organizations next to the workspace list, it means you don’t have access to an organization.

3. Go to Consumption report.

4. Next to one of the calculation methods (New events or Retention events), click Show.
   Result: A graph opens.

   

   In the graph, each column (default view) is one day. If you change the date range to be more than a month, the view changes to monthly.
   Under the graph, the legend informs which color denotes which event.
   By hovering your cursor over a column, you can view the exact numbers.
   The table below the graph shows a part of the data. To see the full table, you can use the Download result option.

5. You can use the options above the graph to change the view, change the data scope, and download the results:

   

   1. To open a list of events and select the ones that you want to include, click Show All .
   2. To change the display mode, use the Logarithmic scale toggle.
   3. To open a list of workspaces and select the ones that you want to include, click All workspaces .
   4. To change the date range from the default (current month) to one of the predefined options or a custom date range, click the date range.
   5. To download an XLSX report, click Download result .
      The report shows data by day (rows) and event type (columns).
   6. To change the graph type, click Column .

Consumption reports

Consumption reports are XLSX spreadsheets with detailed event data. They include calculations made with both calculation methods.

To download a report:

1. Sign in to Synerise.
2. Enter an organization.
   If you can’t see any organizations next to the workspace list, it means you don’t have access to an organization.
3. Go to Consumption report.
4. Next to Consumption report, click Show.
5. Click Select events and:
   1. From the list, select the events which you want to include in the report.
      To select all events, select the checkbox to the left of the number of events.
   2. Click Apply.
6. Click Select workspaces and:
   1. From the list, select the workspaces which you want to include in the report.
      To select all workspaces, select the checkbox to the left of the number of workspaces.
   2. Click Apply.
7. If you want to change the date range:
   1. Click the current date range.
   2. Select a new range from the calendar.
   3. Click Apply.
8. Click Generate report.
   Generating the report may take some time, depending on the size of the dataset.
   Result: When the report is ready, your browser downloads it automatically or opens a dialog to confirm the download, depending on your settings.

Reading the report

To read the report, open it with spreadsheet software, such as Microsoft Excel.
You can filter and/or sort the data in the tables in the report. The available options depend on the software you’re using.

Each sheet includes tables with results of the “New events” and “Retention events” methods of counting events.

Summary sheet

Basic information about the report, such as the list of included workspaces and the generation date.

The table in this sheet shows the aggregated number of events in the entire organization for each month.

All_events_daily_YYYY_MM sheets

These sheets are generated for each month included in the report.

The tables show the number of events that were calculated each day in each workspace. Only workspaces and events with at least 1 occurrence/daily average are listed.

Monthly_summary_YYYY_MM sheets

These sheets are generated for each month included in the report.

The tables show the number of events summarized for the entire month. Only workspaces and events with at least 1 occurrence/daily average are listed.

Events_for_workspace_YYYY_MM sheets

These sheets are generated for each month included in the report.

The tables show the number of events counted in each workspace in a given month. Only workspaces and events with at least 1 occurrence/daily average are listed.