Skip to main content
POST
Create Report

Authorizations

Authorization
string
header
required

Oviond API key (prefix oviond_) sent as a Bearer token — the credential for REST/programmatic and headless integrations. Manage keys in Settings → API Keys. API keys do NOT authenticate the MCP endpoint (/mcp), which uses OAuth 2.1 + PKCE.

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Q1 Report"

type
enum<string>
required
Available options:
REPORT,
DASHBOARD
Example:

"REPORT"

template
enum<string>
required
Available options:
BLANK,
TEMPLATE,
AGENCY
Example:

"BLANK"

client_id
string
Example:

"cliAbc123"

template_id
string

Clone pages and widgets from this template into the new report

pages
object[]
theme_id
string
date_range
object
logo_url
string
auto_refresh_enabled
boolean
show_cover_page
boolean
show_cover_page_name
boolean
show_cover_page_date
boolean
show_cover_page_bg_image
boolean
show_header
boolean
show_header_name
boolean
show_header_date
boolean
show_page_numbers
boolean
show_table_of_contents
boolean
show_date
boolean
show_thank_you
boolean
show_thank_you_bg_image
boolean
show_thank_you_heading
boolean
show_thank_you_message
boolean
orientation
enum<string>
Available options:
portrait,
landscape
paper_size
enum<string>
Available options:
a4,
letter
layout
enum<string>
Available options:
grid,
canvas
cover_page_title
string | null
cover_page_subtitle
string | null
cover_page_pattern_id
enum<string> | null
Available options:
diagonal-corner-bands,
side-rail,
bottom-horizon-band,
diagonal-velocity,
flowing-waves,
orbit-frame,
geo-forms,
prism-tiles,
folded-corners,
mosaic-frame
cover_page_manual_bg_image_url
string | null
thank_you_page_title
string | null
thank_you_page_subtitle
string | null
description
string
status
string
auto_refresh_interval_hours

Auto-refresh cadence: 1 = hourly, 24 = daily

Available options:
1
Example:

24

password_enabled
boolean
password
string
pdf_enabled
boolean

Response

201 - application/json

Report created

success
enum<boolean>
required
Available options:
true
data
object
required