| [ Web Proxy ] |
| Viewing: https://docs.stripe.com/stripe-data/how-sigma-works | [Back] [Original] |
The available data within Sigma is read-only. Queries cant modify existing data or create new transactions.
Sigma provides an interactive SQL environment in the Stripe Dashboard for querying your transactional data. Use Sigma to create custom financial reports for accounting and reconciliation, build reports from pre-configured templates, and track key metrics. All data is read-only and includes information about payments, subscriptions, customers, payouts, and so on.
Sigma is free to use in sandboxes, with no usage limits. You can run unlimited queries against your test data at no cost. Activities in sandboxes dont count toward your charge-based entitlement and dont incur any fees. Use sandboxes to explore Sigmas capabilities before committing to a paid plan.
Reports give you the data required for your accounting and reconciliation workflows. To create a report, query the assistant or write your own report with SQL. The reports you generate can differ from those you generate in the Stripe Dashboard in the following ways:
Data availability: For financial reports, you can find the most recent day of available data by selecting month to date or opening the date picker calendar. In Sigma, the data_load_time parameter provides the timestamp that data is available through.
Time zone: Financial reports in the Stripe Dashboard filter reports by the local time zone by default, but you can switch them to use the UTC time zone. Sigma filters templates by the UTC time zone.
Date range: A selected date range for Stripe Dashboard financial reports, such as Jan. 13 to Jan. 14, filters reports from January 13 00:00:00 up to January 14 23:59:59. A chosen date range filter for Sigma templates for January 13 to January 14 filters reports from Jan 13 00:00:00 up to January 13 23:59:59.
Currency: Financial reports in the Stripe Dashboard always filter data to a single currency. By default, the Sigma report templates return all currencies. You can add a WHERE clause to your Sigma query to restrict your results to a single currency.
Metadata: Financial reports allow you to include metadata. Sigma templates dont include it. You can add metadata to your reports by following the Metadata to column Sigma template.
Reports follow the same availability rules as the Stripe Dashboard. Payout Reconciliation reports are only available for users with the Automatic payouts setting enabled, and Connect variants of reports are only available for users on Stripe Connect.
You can also create a report using a template. By default, these reports run on the last completed month that all data is available for. To change the dates, make a copy of the template and edit the report date intervals. Use the listed templates to generate their related reports and their connected variants:
| Report group | Sigma template name | API report type |
|---|---|---|
| Balance report | Itemized balance change from activity report | balance_change_from_activity.itemized.3 |
| Itemized payouts | payouts.itemized.3 | |
| Payout reconciliation report | Detailed payout reconciliation | payout_reconciliation.itemized.5 |
| Itemized ending balance reconciliation report | ending_balance_reconciliation.itemized.4 |
Create metrics from your Sigma reports and organize them in metric groups to monitor your most important metrics daily. Edit the Sigma chart on your metric to customize the metric preview. Metric groups that dont have a chart enabled display the number of rows in the report.
You can add up to 20 Sigma reports across all metric groups. Only the author of the metric group can edit or delete the metric group. If you delete a metric group, it doesnt impact the reports in that group.
If you currently have an active Sigma subscription and want to cancel it, go to your Sigma settings and click Cancel Stripe Sigma subscription. You can continue using Sigma until the end of the billing cycle, at which point the subscription ends.
| Web Proxy Viewer | New URL | Original Page |