Reports

Create Report

Create a new report.

post/v1/reports

Request

  • Base URL: https://api.oviond.com
  • URL: https://api.oviond.com/v1/reports
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring required
client_idstring
type'REPORT' | 'DASHBOARD' required
template'BLANK' | 'TEMPLATE' | 'AGENCY' required
template_idstring

Clone pages and widgets from this template into the new report

pagesobject[]
theme_idstring
logo_urlstring
auto_refresh_enabledboolean
show_cover_pageboolean
show_cover_page_logoboolean
show_cover_page_client_logoboolean
show_cover_page_agency_logoboolean
show_cover_page_nameboolean
show_cover_page_dateboolean
show_cover_page_bg_imageboolean
show_headerboolean
show_header_logoboolean
show_header_nameboolean
show_header_dateboolean
show_page_numbersboolean
show_table_of_contentsboolean
show_dateboolean
show_thank_youboolean
show_thank_you_bg_imageboolean
show_thank_you_logoboolean
show_thank_you_client_logoboolean
show_thank_you_agency_logoboolean
show_thank_you_headingboolean
show_thank_you_messageboolean
orientation'portrait' | 'landscape'
paper_size'a4' | 'letter'
layout'grid' | 'canvas'
cover_page_titlestring nullable
cover_page_subtitlestring nullable
cover_page_pattern_id'diagonal-corner-bands' | 'side-rail' | 'bottom-horizon-band' | 'diagonal-velocity' | 'flowing-waves' | 'orbit-frame' | 'geo-forms' | 'prism-tiles' | 'folded-corners' | 'mosaic-frame' nullable
cover_page_manual_bg_image_urlstring nullable
thank_you_page_titlestring nullable
thank_you_page_subtitlestring nullable
descriptionstring
statusstring
password_enabledboolean
passwordstring
pdf_enabledboolean

Example request

{
  "name": "Q1 Report",
  "client_id": "cliAbc123",
  "type": "REPORT",
  "template": "BLANK",
  "date_range": {
    "text": "Last 30 Days",
    "compare": "None",
    "current_start": "2026-03-01",
    "current_end": "2026-03-31",
    "previous_start": "2026-02-01",
    "previous_end": "2026-02-28",
    "custom_days": 60,
    "custom_months": 3
  }
}

Response

Report created

successtrue required

Changes

No recorded changes to this operation across all 2 revisions of this API.