Report template attributes

Example of a report template object:

{
    "report": {
        "report_id": "4992166a-d24b-435c-bb3f-d1dd7a083eb8",
        "report_type": "call_summary",
        "name": "Calls Summary Report - Back Office",
        "description": null,
        "tenant_id": null,
        "owner_user_id": null,
        "period": "last_30d",
        "period_begin": null,
        "period_end": null,
        "timezone": "America/Los_Angeles",
        "build_timeout": null,
        "keep_history_days": 30,
        "use_cache": true,
        "user_can_change_filters": true,
        "row_limit": null,
        "filters": [
            {"param": "duration", "param2": "", "op": "greater_than", "val": "1:00"}
        ],
        "created_at": "2024-04-07T14:49:05.928302-07:00",
        "modified_time": "2024-07-17T10:48:01.028081-07:00",
        "page_size": "letter",
        "landscape_orientation": false,
        "email_report": false,
        "email_report_settings": {
            "send_to_emails": [],
            "attachment_formats": ["PDF"]
        },
        "summary_settings": [
            {"name": "count_calls", "header": "Calls - Total"},
            {"name": "minutes_total", "header": "Minutes - Total"}
        ],
        "chart_settings": {
            "chart_style": "bar",
            "dimensions": [{"name": "group", "header": "Group"}],
            "metrics": [{"name": "count_calls", "header": "Calls - Total"}]
        },
        "column_settings": [
            {"name": "group", "header": "Group", "text_align": "left"},
            {"name": "count_calls", "header": "Calls - Total", "text_align": "right"},
            {"name": "minutes_total", "header": "Minutes - Total", "text_align": "right"}
        ],
        "sort_settings": [
            {"name": "group", "header": "Group", "sort": "ASC"}
        ],
        "format_settings": [],
        "options": {},
        "scheduler_type": null,
        "scheduler_minute": null,
        "scheduler_hour": null,
        "scheduler_day_of_month": null,
        "scheduler_month_of_year": null,
        "scheduler_day_of_week": null
    }
}

Attributes

Attribute	Type	Description
report_id	UUID	Unique ID of the template.
report_type	string	Type of the report: call_details - Call Details call_summary - Calls Summary user_call_summary - Calls Summary by Users group_call_summary - Calls Summary by Group tenant_call_summary - Calls Summary by Tenants interval_call_summary - Calls Summary by Interval user_details - User Details tenant_details - Tenant Details audit_trail_details, audit_trail_summary - Audit Trail system_log_details, system_log_summary - System Log
name	string	Title of the report, up to 255 characters.
description	string or null	Description, up to 4096 characters.
tenant_id	UUID or null	Tenant the template belongs to. null for a global template. Available only to API users of the System tenant in multi-tenant deployments.
owner_user_id	UUID or null	Owner of the template. When null, the template is shared with all users of the tenant (or, when tenant_id is null as well, with all tenants).
period	string	Reporting period: last_24h, last_7d, last_30d, last_365d, today, yesterday, this_week, last_week, this_month, last_month, or date_range.
period_begin, period_end	datetime or null	Start and end of the period when period is date_range. ISO 8601 with time zone.
timezone	string	Time zone used for the schedule, the date filters, and the date values in the results, for example America/Los_Angeles.
build_timeout	integer or null	Build timeout in minutes.
keep_history_days	integer	How many days the built reports are kept.
use_cache	boolean	Cache the results of large or frequently accessed reports.
user_can_change_filters	boolean	Users may change the filters when they run the report.
row_limit	integer or null	Maximum number of rows in the report.
filters	list	Filtering criteria. Each item has param (attribute name), param2 (secondary attribute, usually empty), op (operator), and val (value). The parameters and operators are the ones of Advanced search.
created_at, modified_time	datetime	Creation and last modification time.
page_size	string	Page size of the PDF export: letter, a4, or a3.
landscape_orientation	boolean	Landscape orientation of the PDF export.
email_report	boolean	Send the report by email after each build.
email_report_settings	dictionary or null	send_to_emails (list of addresses) and attachment_formats (PDF, XLSX). null when email delivery was never configured.
summary_settings	list	Summary values shown above the table. Each item has name and, optionally, header.
chart_settings	dictionary or null	chart_style (none, pie, column, bar, line, area), dimensions, and metrics (lists of name and header).
column_settings	list	Columns of the table. Each item has name and optionally header, text_align (left, center, right), and optionally text_format (B, I, U), text_color, and background_color. Column names are listed in the Column reference.
sort_settings	list	Sort order. Each item has name, sort (ASC or DESC), and optionally header.
format_settings, options	list, dictionary or null	Additional formatting settings and options of the template.
scheduler_type	string or null	Schedule: hourly, daily, weekly, monthly, crontab, or null when not scheduled.
scheduler_minute, scheduler_hour, scheduler_day_of_month, scheduler_month_of_year, scheduler_day_of_week	string or null	Schedule details. scheduler_hour is a time in the format HH:MM for daily, weekly, and monthly schedules, or an hour (0 to 23) for a crontab schedule. scheduler_day_of_week is 0 (Sunday) to 6 (Saturday).