Run an Existing Report and Email the Output

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Initiates a run of a previously saved report configuration. You can specify email recipients and apply additional filters or options.

The report is generated and delivered via email to the designated recipients.

Retrieve a ReportID

If you need to look up a report ID, consider calling the /api/Report/Query endpoint to query all reports by name, then select the corresponding ReportID value from the response.

See /reference/get-domain-query

/api/Report/Query?columns=ReportID,ReportName,CreatedByUserID,LastRun,Private,TemplateID,Description,Filter,ClientID,Sort,Grouping,Options,FirstHeader,SecondHeader,BenchmarkSetID,BenchmarkDimension,BenchmarkGroupType,BenchmarkGrouping,WizardGroups,Columns,CrossClient,Global,CustomEntity,ShadeAlternateRows,ReportFolderID,Definition,ReportDataSetID,SecondaryFilter,Shared,ViewID,Comments,PromptOptions,RoleID,ClientName,GroupTotals,GrandTotals,RunAtClientOnly,ReportAdHocDomainID,InteractiveOptionSetID,ShareWith,PreciseWidth,DefaultBodyFontSize,DefaultHeaderFontSize,DashboardWidgetDefinitionID,EntryUserID,EntryDate,ModifiedUserID,ModifiedDate,RoleIDs,ExpandByDefault,ConfidentialityStatement,SharedUserIDs
&filter=ReportName:contains:"ReportNameGoesHere"

{
    "List": [
        {
            "ReportID": 98765,
            "ReportName": "Claims Summary - Regional Analysis",
            "CreatedByUserID": 20234,
            "LastRun": "2025-11-15T14:22:10.45",
            "Private": true,
            "TemplateID": 112,
            "Description": "Monthly claims summary for regional breakdown",
            "Filter": "Region:eq:West",
            "ClientID": 30021,
            "Sort": "ClaimAmount:Descending",
            "Grouping": "Region:Ascending:True",
            "Options": "opGrpMore=Region&opGDTMoreAgg=Sum&opGDTMore=ClaimAmount&opTopNGph=15",
            "FirstHeader": "Claims Overview",
            "SecondHeader": "Regional Split",
            "BenchmarkSetID": 45,
            "BenchmarkDimension": "Region",
            "BenchmarkGroupType": "Geographic",
            "BenchmarkGrouping": "Region:Ascending",
            "WizardGroups": "CoverageType,Region",
            "Columns": "ClaimID,ClaimAmount,Region,CoverageType",
            "CrossClient": false,
            "Global": false,
            "CustomEntity": null,
            "ShadeAlternateRows": true,
            "ReportFolderID": 12,
            "Definition": "AdHocRegionalClaims",
            "ReportDataSetID": 567,
            "SecondaryFilter": "CoverageType:eq:Health",
            "Shared": "P",
            "ViewID": 88,
            "Comments": "Used for quarterly review",
            "PromptOptions": true,
            "RoleID": 7,
            "ClientName": "West Coast Insurance",
            "GroupTotals": "true",
            "GrandTotals": true,
            "RunAtClientOnly": false,
            "ReportAdHocDomainID": 33,
            "InteractiveOptionSetID": 19,
            "ShareWith": "FinanceTeam,RegionalManagers",
            "PreciseWidth": true,
            "DefaultBodyFontSize": 12,
            "DefaultHeaderFontSize": 14,
            "DashboardWidgetDefinitionID": 101,
            "EntryUserID": 20234,
            "EntryDate": "2024-12-10T09:15:45.123",
            "ModifiedUserID": 20234,
            "ModifiedDate": "2025-10-05T16:48:32.987",
            "RoleIDs": "7,12",
            "ExpandByDefault": true,
            "ConfidentialityStatement": "Internal Use Only",
            "SharedUserIDs": "20234,20235,20236"
        }
    ],
    "Domain": "Report",
    "Columns": "ReportID,ReportName,CreatedByUserID,LastRun,Private,TemplateID,Description,Filter,ClientID,Sort,Grouping,Options,FirstHeader,SecondHeader,BenchmarkSetID,BenchmarkDimension,BenchmarkGroupType,BenchmarkGrouping,WizardGroups,Columns,CrossClient,Global,CustomEntity,ShadeAlternateRows,ReportFolderID,Definition,ReportDataSetID,SecondaryFilter,Shared,ViewID,Comments,PromptOptions,RoleID,ClientName,GroupTotals,GrandTotals,RunAtClientOnly,ReportAdHocDomainID,InteractiveOptionSetID,ShareWith,PreciseWidth,DefaultBodyFontSize,DefaultHeaderFontSize,DashboardWidgetDefinitionID,EntryUserID,EntryDate,ModifiedUserID,ModifiedDate,RoleIDs,ExpandByDefault,ConfidentialityStatement,SharedUserIDs",
    "Filter": "ReportName:contains:\"Claims Summary - Regional Analysis\"",
    "Sort": "ReportName",
    "StartAt": 0,
    "Take": 30
}

Path Params
integer
required

Numeric primary identifier for the report to execute.

Query Params
string
required

Email address(es) to receive report results. For multiple recipients, provide comma separated list: [email protected],[email protected]

string
required

Indicates if output should be Excel, PDF, PDF (no cover page), Word, or Excel Data Extract. See the Details report route to inspect valid output formats for a given report before requesting as valid formats can vary by report.

string

A reply to email address to be included in the email. This can be a support email address should the recipient have any questions or issues with the report.

Body Params
string

Any filter expressions defined here are applied on top of the report's base filters. Uses Origami Advanced Search syntax. Use /api/Reports/{id}/ValidateFilter to validate filter syntax and behavior.

string

Custom HTML email body. If not provided, uses system default email template.

ReportOptions
array of objects

An array of objects where each report option is identified as a key value pairs.

ReportOptions
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json