Consumption usage dashboard

View as Markdown

The Consumption usage dashboard provides information about credit usage across your organization. You can reference this dashboard to monitor usage and identify what’s driving consumption.

This document explains how to access the Consumption usage dashboard and interpret the data. For information about the types of billable usage events and how they use credits, see About billable usage events.

For information about credit pricing and billing, contact your Account Executive.

Requirements

To access the Consumption usage dashboard, you must be assigned the Admin account type or a custom account type with the View usage dashboard permission enabled.

About the Consumption usage dashboard

The Consumption usage dashboard provides data in two default tabs: Documents and Trends. The data is based on usage events and the credits they use at the document level or in a specific time period.

  • A usage event is any activity Sigma tracks for usage-based billing (i.e., inputs, exports, and integrations).
  • A credit is the unit of billable usage.

An individual usage event can consume a single credit, multiple credits, or no credits (see About billable usage events). Understanding the relationship between usage events and credits is important for interpreting, monitoring, and managing credit usage for your organization.

For more guidance, see Interpret consumption data.

Documents tab

The default Documents tab breaks down credit usage by document. This can help you identify the documents driving the most credit usage and see what usage comes from inputs, exports, or integrations.

FieldDescriptionHow it’s calculated
Org nameThe name of the Sigma organization.No calculation
Document typeThe type of document (workbook, data model, report, etc.).No calculation
Document name [version]The name of the document.If multiple documents have the same name, a number is appended based on when the document was created (lower numbered documents were created earlier).
Total creditsThe total number of credits the document used during the selected period.Sum of input, export, and integration credits.
Input creditsThe number of credits the document used on input events during the selected period.1 credit per row created, updated, or deleted in an input table in the published version of a workbook, up to 100 per action.
Export creditsThe number of credits the document used on export events during the selected period.1 credit per unique file generated when a report is exported and sent to a destination.
Integration creditsThe number of credits the document used on integration events during the selected period.1 credit per API endpoint or stored procedure call triggered by an action.

The Trends tab contains two default charts that help you spot spikes and patterns to understand and anticipate credit usage over time.

  • Credits over time: A bar chart showing credits used in each time interval, viewed by day, week, month, or year.
  • Cumulative credits over time: A waterfall chart tracking the running total of credits used across the selected period, viewed by day, week, month, or year.

Access and view consumption data

Access the Consumption dashboard to view credit usage data for your organization.

  1. Go to Administration > Usage:

    1. In the Sigma header, click your user avatar to open the user menu.
    2. Select Administration to open the Administration portal.
    3. In the side panel, select Usage.
  2. In the Usage page, select the Consumption tab.

  3. In the Consumption usage dashboard, view credit usage by document in the Documents tab, or view credit usage over time in the Trends tab.

  4. (Optional) In the Showing data for filter, change the selection to view data for a specific billing period.

Interpret consumption data

Use the following notes to interpret consumption data and understand what it means for your organization.

  • Update frequency: Consumption data updates hourly. If you don’t see the latest data, it could be processing. Wait a few minutes (or up to an hour) and refresh the page.
  • Billable input event condition: Credits are used for input events that occur in the published version of a workbook. This includes workbook testing performed in the published version. Changes made in a workbook draft don’t use credits. For example, a form that adds rows to an input table uses credits when submitted in the published version, but it doesn’t use credits when submitted in the workbook draft.
  • Input credit usage cap: Each action that updates an input table uses a maximum of 100 credits, regardless of how many rows it changes. If a document’s input credit usage is lower than expected, it could reflect this credit cap.
  • Billable export event condition: Export credits are used by report exports sent to a destination. Credits are not used when reports are downloaded from the Sigma UI and saved locally. Credits are also never used by workbook exports and downloads.
  • Records with no credit usage: The dashboard calculates credit usage for all activity that falls under the event types Sigma tracks for usage-based billing (inputs, exports, and integrations), even when they don’t use credits. This can result in the dashboard including documents that have zero credit usage.