FAQ
Use this page when you know what you want to do, but are not sure which AutoROICalc feature or docs section fits best.
Getting Started
What is AutoROICalc?
AutoROICalc is a reporting and dashboard tool built around business records. You collect records from manual entry, imports, integrations, web events, APIs, or backend jobs, then use them in reports and dashboards.
Start with Getting Started, Quick Start, or Authentication.
What is the recommended first workflow?
A good first workflow is:
- Add or import a few records.
- Create a report from those records.
- Add the report to a dashboard.
- Configure email reporting or integrations when the manual workflow is clear.
See Records, Reports, and Dashboards.
What is the difference between records, reports, and dashboards?
Records are the source data. Reports calculate and visualize records. Dashboards group multiple reports into one view and can send recurring email summaries.
Read more in Records Overview, Reports Overview, and Dashboards Overview.
Records
What is a record?
A record is one measurable business item, such as a sale, lead, cost, conversion, campaign metric, web event, or imported provider row. Records usually include date, time, type, description, source, tags, value, and optional JSON data.
See Managing Records Manually.
When should I use manual records, imports, integrations, or API?
Use manual records for small corrections and one-off data. Use file imports for occasional CSV, XML, or ARC files. Use integrations for supported providers. Use the API or service token when another system should send records automatically.
See Importing Records, Integrations, and API Overview.
What are sources and tags?
Sources describe where the record came from, such as woocommerce, google / cpc, newsletter, or pricing-page. Tags group records for filtering and reporting, such as ecommerce, lead, or paid-order.
Consistent sources and tags make reports easier to compare over time.
What are raw data and custom data?
raw_data keeps the original source payload for traceability. custom_data stores cleaned structured data that can be useful for reports, filters, record insights, or breakdowns.
See Records API.
Why was my record skipped as a duplicate?
AutoROICalc checks for duplicate records so repeated imports or API calls do not create the same business event over and over. If a record has the same core identity as an existing record, it may be skipped or counted as a duplicate.
For imports, review the import result summary in Importing Records.
Reports and Dashboards
What is the difference between a report and a dashboard?
A report calculates one analysis from records, such as revenue by day, cost per conversion, source distribution, or ROI. A dashboard collects multiple reports so they can be reviewed together or emailed on a schedule.
See Reports Overview and Dashboards Overview.
When should I use report templates?
Use report templates when you want to reuse a report structure without manually rebuilding it. Templates are useful for repeated client setups, common internal reporting patterns, and sharing proven layouts.
See Report Templates.
What is a report bundle?
A report bundle exports both the report configuration and the records needed to reproduce it. Use it when you want to move or share a working report together with its data.
See Import, Export, and Reuse.
What are one-click solutions?
One-click solutions are prepared workflows that can install report templates, create dashboards, and configure related setup faster than building everything manually.
See One-Click Solutions.
How does email reporting work?
Email reporting is configured on dashboards. Choose the reports, enable email reporting, set the schedule, and configure recipients or CC addresses. A backend automation job sends the scheduled emails.
See Email Reporting.
Can reports be shared?
Yes. Reports can be shared through public URLs with expiration settings, or shared with another user by username or email when that workflow is available in the app.
See Managing Reports and Report Sharing and Public Reports.
Integrations
Which integrations are supported?
AutoROICalc includes docs for Google Analytics, Google Search Console, Facebook Ads Manager, Google Ads Script, Heureka Statistics, web event tracking, service-token APIs, and scheduled imports.
What is the difference between manual and scheduled imports?
Manual imports run when you start them. Scheduled imports save a provider configuration and let backend automation collect data repeatedly.
See Scheduled Imports.
When should I use web event tracking?
Use web event tracking when website actions should become records, such as form submissions, demo requests, signups, purchases, or key funnel steps.
See Web Event Tracking.
When should I use the Service Token API?
Use the Service Token API from trusted backend code, scripts, private jobs, or server-side automation. Do not call service-token endpoints from browser JavaScript or public client code.
See Service Token API.
Where can I see import job status?
Provider imports can create import jobs with queued, running, completed, or failed status. The integration screens show import progress and summaries where supported.
See Scheduled Imports.
API and CLI
Where is the full API reference?
The complete generated API reference is available at api.autoroicalc.com/docs.
Use API Overview for guidance on which API surface to use.
Should I use /docs/api or the generated API reference?
Use /docs/api for orientation, common workflows, authentication guidance, and examples. Use the generated API reference for exact endpoints, schemas, parameters, and interactive testing.
What is the CLI for?
The CLI is for self-deployed and on-premise operators who run the backend directly. It supports database setup, users, tokens, records, reports, automation jobs, sessions, email smoke tests, and backups.
See CLI Overview.
Should regular cloud users use CLI commands?
No. CLI commands are backend operator tools. Cloud or hosted users should normally use the web UI, integrations, and API.
Account and Settings
Where do I configure email sending?
Configure SMTP/email settings in the app settings. These settings are used by dashboard email reporting and related notification workflows.
See Email Settings.
Where do I change timezone, language, and number format?
Use localization and display settings for language, timezone, and number formatting.
Can I customize how sources, tags, and types look?
Yes. Report appearance settings let you customize colors and icons for record sources, record tags, record types, report tags, and dashboard tags.
See Report Appearance Settings.
Can I import or export appearance settings?
Yes. Appearance settings can be exported and imported with ARC-based settings files, which is useful when moving visual conventions between environments or accounts.
See Settings Import.
What happens when I delete account data?
Account data deletion removes user data such as records, reports, dashboards, and scheduled integrations after token confirmation. It is intended for clearing account content while keeping the account itself.
What happens when I close an account?
Account closure is a stronger action. After token confirmation, it removes identity-related account data, service/web tokens, settings, and the user account record.
Self-Hosted and On-Premise
Where should self-hosted operators start?
Start with Deployment Options, then review CLI Overview, API Overview, and Features Overview.
How are scheduled jobs run in self-hosted deployments?
Scheduled jobs are handled by backend automation commands. Operators usually run them through cron, systemd timers, or another scheduler.
See CLI Overview and Scheduled Imports.