---
title: "Create Report"
method: POST
path: "/v1/reports"
tags: ["Reports"]
---

# Create 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

Create a new report.

## Request body

- CreateReportRequest
  - `name` string, required
  - `client_id` string
  - `type` 'REPORT' | 'DASHBOARD', required
  - `template` 'BLANK' | 'TEMPLATE' | 'AGENCY', required
  - `template_id` string: Clone pages and widgets from this template into the new report
  - `pages` object[]
  - `theme_id` string
  - `date_range` DateRange
    - `text` 'Today' | 'Yesterday' | 'Last 7 Days' | 'Last 30 Days' | 'Last 60 Days' | 'Custom Days' | 'This Month' | 'Last Month' | 'Custom Months' | 'Last 2 Months' | 'Last 3 Months' | 'Last 12 Months' | 'This Year' | 'Last Year' | 'Custom'
    - `compare` 'None' | 'Period' | 'Month' | 'Year' | 'Custom'
    - `include_today` boolean
    - `current_start` string
    - `current_end` string
    - `previous_start` string
    - `previous_end` string
    - `custom_days` number
    - `custom_months` number
  - `logo_url` string
  - `auto_refresh_enabled` boolean
  - `show_cover_page` boolean
  - `show_cover_page_logo` boolean
  - `show_cover_page_client_logo` boolean
  - `show_cover_page_agency_logo` boolean
  - `show_cover_page_name` boolean
  - `show_cover_page_date` boolean
  - `show_cover_page_bg_image` boolean
  - `show_header` boolean
  - `show_header_logo` 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_logo` boolean
  - `show_thank_you_client_logo` boolean
  - `show_thank_you_agency_logo` boolean
  - `show_thank_you_heading` boolean
  - `show_thank_you_message` boolean
  - `orientation` 'portrait' | 'landscape'
  - `paper_size` 'a4' | 'letter'
  - `layout` 'grid' | 'canvas'
  - `cover_page_title` string, nullable
  - `cover_page_subtitle` string, 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_url` string, nullable
  - `thank_you_page_title` string, nullable
  - `thank_you_page_subtitle` string, nullable
  - `description` string
  - `status` string
  - `auto_refresh_interval_hours` union: Auto-refresh cadence: 1 = hourly, 24 = daily
    - 1
    - 24
  - `password_enabled` boolean
  - `password` string
  - `pdf_enabled` boolean

## Response `201`

Report created

- CreateReportResponse
  - `success` true, required
  - `data` object, required
    - `id` string, required

---

[API](https://skmtc.dev/oviond/apis/oviond-backend-api.md) · [All operations](https://skmtc.dev/oviond/apis/oviond-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/oviond/apis/oviond-backend-api/revisions/4cb0a07daf41?raw)