latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

Report Management API

Execute saved report with optional recipient, subject, and message overrides

post/api/2.0/reports/{objectId}/run

Path parameters

objectIdinteger required

Report ID to be executed

Request body

recipientsstring[]
ccstring[]
bccstring[]
subjectstring
messagestring

Example request

{
  "reportContentFilters": [
    {
      "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
      "controlType": "single,picker,slider,range_time_slider",
      "plainControlType": "single,multiple,tree,custom"
    }
  ]
}

Response

Success

executionDateinteger

Date in milliseconds

executionStatus'UNKNOWN' | 'RUNNING' | 'SUCCESS' | 'FAILURE' | 'ALERT' | 'TIMEOUT'

Status

durationinteger

Duration