Skip to main content

Analytics

Analytics runs saved, read-only queries. Define a query once, then run it by name with different values each time, either against the data your app already stores or against a database you operate.

How Analytics is organized​

A query belongs to one app. Its connection mode decides what it reaches, and its parameters decide what it returns on a given run.

The query stores the statement, not a reusable result set. Results are not precomputed, so a run reflects the data at that moment. Analytics does persist a record of each run, including the parameter values and any error text, so don't pass sensitive values as parameters.

What you can do​

CapabilityWhat it gives youStart here
Saved queriesA named, addressable statement that is validated when you save itSaved queries
Two connection modesRead your site's own tables, or a database you operateConnection modes
ParametersValues sent with each run are treated as data and cannot change what the query doesPlaceholders and bound values
Per-caller resultsOne query that returns only the signed-in caller's own rowsThe built-in user profile
Read-only executionA query must be a single read statement to save, and each SQL connector runs it with a read-only database settingRely on read-only enforcement
Execute authorizationMembers of the organization that owns the site can run any query; other users need a role on the app and must pass the query's policyWho can run and manage queries
Management accessManaging saved queries currently requires only sign-in to the siteWho can run and manage queries

Choose an interface​

InterfaceBest forSetup
TaruviBase ConsoleCreating, editing, and running queries interactivelyCreate and manage a saved query
JavaScript SDKRunning a saved query from a browser or server applicationJavaScript SDK
Python SDKRunning a saved query from services, jobs, or scriptsPython SDK

Both SDKs cover execution only. Use TaruviBase Console to create, find, edit, tag, and delete saved queries, then use an SDK to execute them from application code. The full interface list is in the reference.

What Analytics does not do​

Analytics does not write data. A SQL query that contains a write anywhere in its statement is refused when it is saved, and each SQL connector runs queries with a read-only database setting. For an external database, still use credentials that cannot write, so the database itself refuses a write.

It also does not expose a browsable history. The execution wire response and both SDK results include an execution key you can quote when reporting a problem, but past executions cannot be listed or replayed. The Console doesn't show the execution key.

Start here​

  1. Save and run your first query against disposable data in a non-production site.
  2. Read the concepts to understand saved queries, connection modes, and parameters.
  3. Create and manage saved queries for real use — name them, tag them, and edit them safely.
  4. Review security and limits before exposing a query to anyone else.
  5. Keep troubleshooting nearby; most problems surface when a query is saved.