SoraiDocs
GuidesAPI reference

sorai analytics overview

Revenue by currency, orders, visitors, and the view, checkout and purchase funnel for a date range.

Days are UTC. Revenue is never converted between currencies.

sorai analytics overview [flags]

Flags

  • --store <id|slug>: A store id or slug. Defaults to SORAI_STORE, the saved login's store, or the only store.
  • --from <string>: Start of the range, inclusive. Defaults to 30 days before to. An RFC 3339 date-time (2026-08-29T00:00:00Z), a bare YYYY-MM-DD date, or a date-time with no seconds.
  • --to <string>: End of the range, inclusive. Defaults to today. An RFC 3339 date-time (2026-08-29T00:00:00Z), a bare YYYY-MM-DD date, or a date-time with no seconds.

Permissions

Needs a key with the analytics:read permission.

On this page