A valid request URL is required to generate request examples{
"Name": "<string>",
"Columns": "<string>",
"CreatedTime": "2023-11-07T05:31:56Z",
"TimePeriod": "<string>",
"Type": "<string>",
"TimePeriodEnd": "2023-11-07T05:31:56Z",
"Summary": "<string>",
"EmailReport": true,
"Filters": "<string>",
"ModifiedTime": "2023-11-07T05:31:56Z",
"TimePeriodStart": "2023-11-07T05:31:56Z",
"IsRunning": "<string>",
"EndDate": "2023-11-07T05:31:56Z",
"CreatedBy": "<string>",
"GroupRows": "<string>",
"EmailSubject": "<string>",
"NextRunTime": "2023-11-07T05:31:56Z",
"Format": "<string>",
"Schedule": "<string>",
"StartDate": "2023-11-07T05:31:56Z",
"EmailRecipients": "<string>"
}This response has no body data.{
"error": {
"code": "<string>",
"message": "<string>"
}
}Update reports
Updates the specified reports object.
A valid request URL is required to generate request examples{
"Name": "<string>",
"Columns": "<string>",
"CreatedTime": "2023-11-07T05:31:56Z",
"TimePeriod": "<string>",
"Type": "<string>",
"TimePeriodEnd": "2023-11-07T05:31:56Z",
"Summary": "<string>",
"EmailReport": true,
"Filters": "<string>",
"ModifiedTime": "2023-11-07T05:31:56Z",
"TimePeriodStart": "2023-11-07T05:31:56Z",
"IsRunning": "<string>",
"EndDate": "2023-11-07T05:31:56Z",
"CreatedBy": "<string>",
"GroupRows": "<string>",
"EmailSubject": "<string>",
"NextRunTime": "2023-11-07T05:31:56Z",
"Format": "<string>",
"Schedule": "<string>",
"StartDate": "2023-11-07T05:31:56Z",
"EmailRecipients": "<string>"
}This response has no body data.{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Path Parameters
The key Name
Body
The reports entity to update.
The report name.
The columns in the report. Required when creating a new report. Available values include one or more of: 'WorkspaceId, ConnectorId, ConnectorType, Year, Quarter, Month, Week, SenderISAId, ReceiverISAId, TransactionSet, AllTransactions, TransactionsSent, TransactionsReceived, TotalProcessingTime, TotalFileSize, Successful, Error, Warning'.
The time the report was created.
The time period, such as Last3Months or YearToDate, that the report uses to pull data. Available values are 'All, LastMonth, Last3Months, Last6Months, Last12Months, MonthToDate, QuarterToDate, YearToDate, SinceLastRun, Custom'.
The report type. Available values are 'Transactions, Application'.
If the TimePeriod is Custom, this is the report end time. For example: 2026-02-11T17:00:00.0000-07:00
Any summary information, such as Total or Average, that should be included in the generated report.
Whether to send the report via email.
Any filters that should be used for the report, such as ConnectorType=SFTP,FTP;ConnectorId=SFTP1,SFTP2,FTP1,FTP2.
The time the report was last modified.
If the TimePeriod is Custom, this is the report start time.
Whether the report is running.
For any TimePeriod other than Custom, this is the report end date in this format: YYYY-MM-DD. For example: 2026-01-28
The user who created the report.
The rows, such as Week or ConnectorType, to group by in the report. Available values include one or more of: 'WorkspaceId, ConnectorCategory, ConnectorId, Year, Quarter, Month, Week, SenderISAId, ReceiverISAId, TransactionSet'.
If EmailReport is True, this is the email subject line.
The next time the report is scheduled to run.
The report format, such as CSV.
The cron schedule that controls when the report is run.
For any TimePeriod other than Custom, this is the report start date in this format: YYYY-MM-DD. For example: 2026-01-28
If EmailReport is True, this is a comma-separated list of email recipients.
Response
EntitySet reports
The report name.
The columns in the report. Required when creating a new report. Available values include one or more of: 'WorkspaceId, ConnectorId, ConnectorType, Year, Quarter, Month, Week, SenderISAId, ReceiverISAId, TransactionSet, AllTransactions, TransactionsSent, TransactionsReceived, TotalProcessingTime, TotalFileSize, Successful, Error, Warning'.
The time the report was created.
The time period, such as Last3Months or YearToDate, that the report uses to pull data. Available values are 'All, LastMonth, Last3Months, Last6Months, Last12Months, MonthToDate, QuarterToDate, YearToDate, SinceLastRun, Custom'.
The report type. Available values are 'Transactions, Application'.
If the TimePeriod is Custom, this is the report end time. For example: 2026-02-11T17:00:00.0000-07:00
Any summary information, such as Total or Average, that should be included in the generated report.
Whether to send the report via email.
Any filters that should be used for the report, such as ConnectorType=SFTP,FTP;ConnectorId=SFTP1,SFTP2,FTP1,FTP2.
The time the report was last modified.
If the TimePeriod is Custom, this is the report start time.
Whether the report is running.
For any TimePeriod other than Custom, this is the report end date in this format: YYYY-MM-DD. For example: 2026-01-28
The user who created the report.
The rows, such as Week or ConnectorType, to group by in the report. Available values include one or more of: 'WorkspaceId, ConnectorCategory, ConnectorId, Year, Quarter, Month, Week, SenderISAId, ReceiverISAId, TransactionSet'.
If EmailReport is True, this is the email subject line.
The next time the report is scheduled to run.
The report format, such as CSV.
The cron schedule that controls when the report is run.
For any TimePeriod other than Custom, this is the report start date in this format: YYYY-MM-DD. For example: 2026-01-28
If EmailReport is True, this is a comma-separated list of email recipients.