Public API reference launched
The Oviond REST API reference is now live on Mintlify. The full endpoint catalog — projects, widgets, integrations, automations, public share links — is auto-generated from the backend’s OpenAPI spec and kept in sync on every release.- Interactive Try it console against
https://api.oviond.com - Bearer-token authentication via API keys generated in Settings → API Keys
- Grouped by domain: Account, Projects, Widgets, Integrations, Automations, Public, and more
Scheduled report delivery
Schedule reports to be emailed to clients on a recurring cadence. Automations support pause/unpause, run history, and on-demand test sends.POST /v1/automations— create an automationPOST /v1/automations/:id/pauseand/unpausePOST /v1/automations/:id/test— send a test email without logging a runGET /v1/automations/history— inspect past deliveries
PDF generation
Render any report to PDF with selectable format and orientation. Jobs run asynchronously — enqueue, then poll for status until the download URL is ready.POST /v1/pdf/generate— enqueue a jobGET /v1/pdf/status/:job_id— poll until complete
Fully branded client experiences
Serve reports under your own domain with end-to-end white label — logo, favicon, colors, OG preview, password gating, and error messaging.PUT /v1/white-label— update branding settingsPOST /v1/white-label/domains— add a custom domain (auto-detects Cloudflare / GoDaddy)GET /v1/white-label/domains/:id/status— check DNS verification via Vercel
Reusable report scaffolds
Create templates from existing reports (pages + widgets + date settings carry over) and apply themes to control typography, color palette, and chart styling across any project.POST /v1/templates— create a template, optionally copying from a projectPOST /v1/themes— create a theme (chart colors auto-derive fromprimary_color)- Shared library templates available to every account
Uploads, folders, and S3-backed storage
Upload images and assets, organize them into folders, and reference them directly from widgets. Deletes are soft — files stay in S3 for recovery.POST /v1/media/upload-url— request a pre-signed upload URLGET /v1/mediaand/v1/media/folders- Bulk delete, rename, and folder management
Programmatic access
Issue API keys from Settings → API Keys to call the REST API outside the app. Keys can be revoked instantly and support role-based scopes.POST /v1/api-keys— create a key (secret shown once)POST /v1/api-keys/:id/revoke
Workspace-level notifications
In-app alerts for automation failures, integration disconnects, and team events — with read/unread tracking and per-user delivery preferences.GET /v1/alerts— list recent alertsGET /v1/alerts/unread-countPUT /v1/alerts/preferences— opt in/out of email delivery
Custom KPIs and reusable queries
Define formulas that combine metrics across integrations (e.g.Revenue / Sessions), and save data-query configurations you use across multiple reports.POST /v1/calculated-metrics— define a formulaPOST /v1/saved-metrics— save a query config- Both support duplicate for quick variants
Bring your own CSVs
Upload CSV datasets and query them alongside integration data. Useful for offline sales, forecasts, or any metric that doesn’t live in a connected platform.POST /v1/custom-data— upload and parse a datasetPOST /v1/custom-data/:id/duplicate
Connect marketing platforms via OAuth
OAuth 2.1 connection flow for Google Analytics, Meta Ads, LinkedIn, and the rest of the Oviond integration catalog. Datasources link to clients; profiles are selected per integration.GET /v1/integrations/auth-url— start an OAuth flowPOST /v1/integrations/auth— exchange the codePOST /v1/data/query— pull metrics from connected sources
The report canvas
The core editor API — create reports, add pages, and drop widgets (charts, KPIs, text, images, embeds, goals, buttons). Atomic/save endpoint persists pages and bulk widget upserts in a single call.POST /v1/projects— create a report or dashboardPOST /v1/pages— add a page to a project or templatePOST /v1/widgets— batch upsert widgets
Client workspaces
Every report ties to a client. Organize clients into folders, bulk-delete, and filter by folder across the dashboard.POST /v1/clients— create a clientPOST /v1/folders— organize clients into foldersPUT /v1/clients/:id/move— move between folders
Multi-user accounts
Invite team members, assign roles, and restrict users to a subset of projects. Account-level settings for company info, branding, and billing.POST /v1/users/invite— invite a team memberGET /v1/accountand/v1/account/usage— plan + usage snapshotPUT /v1/branding— set logo, favicon, brand color
Shareable report links
Every project gets a shortnano_id share URL. Public endpoints return the full rendered payload — widgets, branding, theme, white label — in a single request, with no authentication required.GET /v1/public/resolve/:nano_id— resolve a short linkGET /v1/public/report/:account_id/:client_id/:project_id— full render payloadGET /v1/public/og-meta/:nano_id— OG tags for link previews