List and search report templates

List all report templates:

GET /api/v2/reports.json

Example of response:

{
    {
        "report_id": "4992166a-d24b-435c-bb3f-d1dd7a083eb8",
        "report_type": "call_summary",
        "name": "Call summary",
        "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": [],
        "created_at": "2021-04-07T14:49:05.928302-07:00",
        "page_size": "letter",
        "landscape_orientation": false,
        "email_report": false,
        "email_report_settings": {
            "send_to_emails": []
        },
        "summary_settings": [
            {
                "name": "count_calls",
                "header": "Calls - Total"
            },
            {
                "name": "minutes_total",
                "header": "Minutes - Total"
            },
            {
                "name": "user_recording_license",
                "header": "License - Recording"
            },
            {
                "name": "n_rows",
                "header": "# of rows"
            }
        ],
        "chart_settings": {
            "chart_style": "bar",
            "dimensions": [
                {
                    "name": "group",
                    "header": "Group"
                }
            ],
            "metrics": [
                {
                    "name": "count_calls",
                    "header": "Calls - Total"
                },
                {
                    "name": "minutes_total",
                    "header": "Minutes - Total"
                }
            ]
        },
        "column_settings": [
            {
                "name": "group",
                "header": "Group",
                "text_align": "left"
            },
            {
                "name": "user",
                "header": "User",
                "text_align": "right"
            },
            {
                "name": "count_calls",
                "header": "Calls - Total",
                "text_align": "right"
            },
            {
                "name": "minutes_total",
                "header": "Minutes - Total",
                "text_align": "right"
            },
            {
                "name": "user_name",
                "header": "User - Name",
                "text_align": "right"
            },
            {
                "name": "user_recording_license",
                "header": "License - Recording",
                "text_align": "right"
            }
        ],
        "sort_settings": [
            {
                "name": "group",
                "header": "group",
                "sort": "ASC"
            },
            {
                "name": "user",
                "header": "user",
                "sort": "ASC"
            },
            {
                "name": "user_name",
                "header": "user_name",
                "sort": "ASC"
            }
        ],
        "scheduler_type": null,
        "scheduler_minute": null,
        "scheduler_hour": null,
        "scheduler_day_of_month": null,
        "scheduler_month_of_year": null,
        "scheduler_day_of_week": null,
        "modified_time": "2024-07-17T10:48:01.028081-07:00",
        "_version_": 1
    },
    {
        "report_id": "8869de78-5834-4e29-8393-78cfe062ce12",
        "report_type": "audit_trail_summary",
        "name": "Audit trail summary",
        "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": null,
        "row_limit": null,
        "filters": null,
        "created_at": "2021-01-21T15:32:49.456271-08:00",
        "page_size": "letter",
        "landscape_orientation": false,
        "email_report": false,
        "email_report_settings": {
            "send_to_emails": []
        },
        "summary_settings": [
            {
                "name": "total_events",
                "header": "Total events"
            }
        ],
        "chart_settings": {
            "chart_style": "column",
            "dimensions": [
                {
                    "name": "audit_trail_resource",
                    "header": "Resource"
                }
            ],
            "metrics": [
                {
                    "name": "total_events",
                    "header": "Total events"
                }
            ]
        },
        "column_settings": [
            {
                "name": "audit_trail_group",
                "header": "GROUP",
                "text_align": "right"
            },
            {
                "name": "audit_trail_resource",
                "header": "RESOURCE",
                "text_align": "left",
                "text_format": [
                    "B"
                ]
            },
            {
                "name": "audit_trail_action",
                "header": "ACTION",
                "text_align": "left",
                "text_format": [
                    "B"
                ]
            },
            {
                "name": "total_events",
                "header": "Total events",
                "text_align": "right"
            }
        ],
        "sort_settings": [
            {
                "name": "audit_trail_resource",
                "header": "audit_trail_resource",
                "sort": "ASC"
            },
            {
                "name": "audit_trail_action",
                "header": "audit_trail_action",
                "sort": "ASC"
            }
        ],
        "scheduler_type": null,
        "scheduler_minute": null,
        "scheduler_hour": null,
        "scheduler_day_of_month": null,
        "scheduler_month_of_year": null,
        "scheduler_day_of_week": null,
        "modified_time": "2024-07-17T10:48:01.028081-07:00",
        "_version_": 1
    },
    "total": 2,
    "next_url": null
}

See also Paging through collections

Search reports:

• Search by report name:

  GET /api/v2/reports.json?search_term=MyReport
  

• Search by report type:

  GET /api/v2/reports.json?report_type=call_summary
  

• Search by tenant id

  GET /api/v2/reports.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff
  

• Search by report owner

  GET /api/v2/reports.json?user_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff
  

• Search by multiple parameters (user_id and search_term)

  GET /api/v2/report.json?user_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff&search_term=Contoso