Skip to main content

Usage Data Dashboard and overage calculations

Get an overview of your platform usage to better understand your billing processes and learn how the Productsup platform calculates overages.

According to the Productsup License Agreement, you get access to the platform based on your contract entitlement. If you exceed your entitlement and overuse the platform, you face additional charges for overages. The platform automatically calculates overages based on particular metrics.

This document explains the formulas used to calculate excessive use of the Productsup platform.

The Usage data dashboard overviews your platform usage and helps you understand charges and overages. The Usage data dashboard shows the essential metrics affecting invoices, such as Items, Exports, Sites, Users, and Syndication frequency overages.

The dashboard is available in the Billing section of the platform, and only organization admins can access it.

You can also download the detailed usage reports in CSV format.

To access the Usage data dashboard:

  1. Select your admin profile menu in the top-right corner and choose Billing.

  2. Select the Usage tab.

    Tip

    You can find metrics' meanings in the info tooltips () next to each metric name.

    Usage dashboard

Overage calculation metrics

The platform calculates overages for the following metrics:

Note

Overage calculations exclude the sandbox project usage.

Max items

The platform identifies the maximum items imported or exported daily for each non-manual site run for every organization or edition and calculates the monthly overage. By non-manual run, we mean that the site scheduling, a trigger of another site, or an API triggers the site.

The formula for overage calculation is:

Overage = [the highest number of items per day within a month] - [your service entitlement]

For example, if the item entitlement is 5000, the overage calculation looks as follows:

Max items

The overage for January 2021 is 500, calculated as 10000 actual items - 5000 items from the entitlement. There are no overages in February 2021, as the platform imported or exported exactly 5000 items.

Exports

The platform takes daily snapshots of the number of your configured main and standard exports for every organization or edition and calculates the monthly overage.

The overage calculations for the Exports metric takes into account the export clustering. See Export clustering to learn how it works.

The formula for overage calculation is:

Overage = [the total number of clustered exports within a month] - [your service entitlement]

Note

The platform doesn’t count the sandbox project’s exports.

For example, if the Exports entitlement is 60, the overage calculation looks as follows:

Exports overages

The overage for January 2021 is 40, calculated as 100 added exports - 60 exports from the entitlement. There are no overages in February 2021, as the customer added only 50 exports.

Export clustering

The Productsup platform uses export clustering to calculate overages for exports. Productsup has three (3) types of exports:

  • Standard export: highlighted in green in the following example tables.

  • Main export: highlighted in yellow in the following example tables.

  • Sub-export: highlighted in red in the following example tables.

Standard exports

A standard export is the default export that doesn't have any classifications or sub-exports. For example, Google Merchant Center.

To count standard exports on the site level, use the following formula:

[The same standard export added N times] = N

For example:

Standard export

The platform counts the standard export A every time the customer adds it, which makes three (3) exports. Totally: three (3) exports.

Main exports

The main export is a standard export that can have one or more sub-exports associated with it. For example, Upljft - Basic catalog is the main export for sub-exports Upljft - Country feed and Upljft - Language feed. This system helps to avoid overages by clustering multiple similar sub-exports that send data to the same channel but for different countries, languages, etc.

To count main exports on the site level, use the following formulas:

  • [The same main export added N times] = 1

    For example:

    Main export count

    The platform counts the standard export A every time the customer adds it, which makes two (2) exports, while it counts two (2) times of the main export B as only one (1) export. Totally: three (3) exports.

  • [N different main exports added] = N

    For example:

    Different_main_exports.png

    The platform counts the standard export A every time the customer adds it, which makes two (2) exports, while it counts two (2) times of the main export B as only one (1) export, and one (1) time of the main export C as one (1) export. Totally: four (4) exports.

Sub-exports

A sub-export is an export that belongs to the main export and helps cluster multiple similar exports that send data to the same channel but for different countries, languages, etc. However, there might be cases where a sub-export doesn’t belong to the main export because there is no need of the main export for certain setups. In this case, the platform creates a non-global placeholder for the main export and associates sub-exports with it. For example, FabDis exports, such as Fabdis 3.0 - C01_Extension, are sub-exports that belong to the FabDis 3.0 - Master Channel Shell non-global placeholder main export.

To count sub-exports on the site level, use the following formulas:

  • [The same sub-export added N times] = 1

    For example:

    Sub Channel

    The platform counts one (1) standard export A, one (1) main export B, and two (2) times added the same sub-export C belonging to the main export D as only one (1) export. Totally: three (3) exports.

  • [N different sub-exports belonging to the same main export] = 1

    For example:

    Different sub-exports for the same main export

    The platform counts one (1) standard export A, one (1) main export B, and two (2) times added the same sub-export C and one (1) time added sub-export F, both belonging to the main export D, that count as only one (1) export. Totally: three (3) exports.

  • [Sub-exports from N different main exports] = N

    For example:

    Miltiple sites, different exports

    The platform makes the following calculation:

    1. Counts every time the customer adds each standard export A and H per site, which makes five (5) exports.

    2. Counts the main exports B and E only once for each export ID per site, regardless of how many times the customer added them. This makes four (4) exports.

    3. Counts two (2) sub-exports C belonging to the main export D, and one (1) sub-export F belonging to the main export G, only once for each main export per site. This makes three (3) exports.

    4. Totally: 12 exports.

Edition users

The platform makes a daily snapshot of the number of users in each organization or edition and calculates the monthly overage.

The formula for overage calculation is:

Overage = [the highest number of users daily within a month] - [your service entitlement]

For example, if the Edition Users entitlement is 10, the overage calculation looks as follows:

Edition Users

The overage for January 2021 is 10-10=0. For February and March 2021, it is 15-10=5.

Onboarding Catalogs

The platform makes a daily snapshot of the number of sites or catalogs in every Seller/Vendor Onboarding Module in each organization and measures monthly overage.

The formula for overage calculation is:

Overage = [the highest number of catalogs within a month] - [your service entitlement]

For example, if the site or catalog entitlement is 10, the overage calculation looks as follows:

Onboarding Catalogs

The overage for January 2021 is 30-10=20. For February and March 2021, it is 10-10=0 and 5-10=-5, and both result in zero (0) overages.

Syndication frequency overages

The platform makes a daily snapshot of the number of syndications per export in each organization and calculates the monthly overage.

Warning

The platform doesn't count manual site runs triggered when you select the Export or Run buttons. However, if the manual site run triggers another site run, the triggered site run counts as syndication and increases the total syndication frequency count by one (1). To prevent the overages in this case, check the triggering settings of your sites in Scheduling. See Set up scheduling and triggering processes in Scheduling for more information.

The following example shows overage calculation.

Suppose the organization has three (3) active exports: A and B in the site 1, and C in the site 2. The syndication frequency entitlement is 1.

The following syndication frequency happened during January 2021:

  • 01.01.2021: Three (3) syndication cases for export A and one (1) case for each B and C exports.

  • 02.01.2021: Two (2) syndication cases for export A, one (1) case for export B, and two (2) cases for export C.

  • 03.01.2021: One (1) syndication case for each export.

Syndication frequency daily snapshot

The platform doesn’t count the number of syndications but only the fact of exceeding the entitlement per export per day, and sums up these daily cases for a month.

In this example, the number of daily syndications with overages on 01.01.2021 is only one (1) because only export A exceeds the entitlement. On 02.01.2021, it is two (2) as two (2) exports exceed the entitlement. And on 03.01.2021, there were no overages. See the following table:

Number of daily syndication with overages

January overages equal the sum of one (1) exceeding syndication case on 01.01.2021 and two (2) cases on 02.01.2021, which makes three (3) in total for January. See the following table:

Syndication frequency overage results example

Syndication frequency overages details

You can view details of syndication frequency overages per day:

  1. Select a necessary month bar on the Syndication frequency overages graph.

    Syndication Frequency Overages graph
  2. Select a necessary day bar on the day view of the Syndication frequency overages graph.

    Day view of Syndication Frequency Overage

The Syndication Frequency Overages Details table shows all sites that lead to overages. You can check the following metrics for each site in your organization for a selected day:

  • Overage.

  • Exports.

  • Entitlement.

  • Syndications.

Syndication frequency

You can do the following actions:

  1. Select another day.

    1. Open the day picker dropdown. The red dots in the top-right corner of a day indicate the days with overages.

      day_selection_overages.png
    2. Select a necessary day.

  2. View the list of exports for each site and deactivate unnecessary exports to reduce overages:

    1. Select a number next to the necessary site in the Exports column to get to the Export Overview page of the site.

    2. Check the active exports and deactivate unimportant exports.

  3. View the scheduling of each site:

    1. Hover over a necessary site line and select View Scheduling to get to the Site Scheduling page.

    2. Adjust your schedule to match your entitlement. See Schedule your site runs in Site Scheduling.

Download the usage reports

You can download the detailed usage reports in CSV format. The reports contain information for one selected month with daily data. You get a zip folder named usage-report-YYYY-MM that consists of the following CSV files:

  • Excluded sites with names.

  • Exports with names.

  • Max items with names.

  • Sites with names.

  • Syndication frequency with names.

  • Users with names.

Note

You can download the reports only for the months starting from November 2022.

To download the reports, do the following:

  1. Go to the Usage tab.

  2. Select the download icon_report_download.png icon.

    Download the Usage reports
  3. Select the year and month for the report.

    Download CSV report
  4. Select Download.

Tip

If the CSV files show all data in a single cell instead of separate rows and columns, you may need to set a delimiter in the Table settings of your tool:

For Numbers on macOS, do as follows:

  1. Select the Table button.

  2. Select the Adjust Import Settings… button.

  3. Select a comma (,) in Separate Value Using.

  4. Select Update Table.

For Microsoft Excel, do as follows:

  1. Go to the Data tab.

  2. In Get & Transform Data, select From Text/CSV.

  3. In Import Data, find and select your CSV file.

  4. In Text Import Wizard, select Delimited and select Next.

  5. Choose a comma (,) or a semicolon (;) as a delimiter and select Next.

  6. Check if the preview shows all the necessary columns highlighted and select Next.

  7. Choose the appropriate data format for each column, such as General, Text, or Date, and select Finish.

The Productsup Help Center disclaims all responsibility and accountability for the accuracy and relevance of the processes, features, UI elements, and other information mentioned in these instructions about third-party tools. The instructions aim to help you perform activities outside the Productsup platform.