Report APIs

Post /api/v3/report/reportgroup

Operation: CreateReportGroupV3 Permissions: ReportGroups (Manage)


Get /api/v3/report/reportgroup

Operation: GetReportGroupsV3


Delete /api/v3/report/reportgroup/{reportGroupId}

Operation: DeleteReportGroupV3 Permissions: ReportGroups (Manage)

Deletes a Report Group


Put /api/v3/report/reportgroup/{reportGroupId}

Operation: EditReportGroupV3 Permissions: ReportGroups (Manage)


Get /api/v3/report/reportgroup/{reportGroupId}

Operation: GetReportGroupV3


Get /api/v3/report

Operation: GetSpecificReportsV3 Permissions: Reports (Run)

Get a filterable list of installed, saved, and shared reports available to the current user.


Get /api/v3/report/{specificReportId}

Operation: GetSpecificReportV3 Permissions: Reports (Run)

Get a report by its specificReportID.


Put /api/v3/report/{specificReportId}

Operation: EditSpecificReportV3 Permissions: Reports (Run)

Edit a specific report


Delete /api/v3/report/{specificReportId}

Operation: DeleteSpecificReportV3 Permissions: Reports (Run)


Post /api/v3/report/install/latest

Operation: InstallReportsV3 Permissions: ReportAdministrator (Manage)


Get /api/v3/report/{specificReportId}/filter

Operation: GetReportFiltersV3 Permissions: Reports (Run)

Get the filters for a specific report.


Put /api/v3/report/{specificReportId}/filter

Operation: EditReportFiltersV3 Permissions: Reports (Run)

Edit the filters for a specific report.


Get /api/v3/report/exec/{specificReportId}

Operation: RunReportV3 Permissions: Reports (Run)

Run a report and download in the provided format


Post /api/v3/report/exec/{specificReportId}

Operation: DistributeReportV3 Permissions: Reports (Run)

Execute a report, save it in a given format, and email it to a list of recipients.
If distributing reports, returns a 204 No Content if onlySendIfData is set to True and the report generated no data;
returns a 200 and the generated report for download or an empty body if onlySendIfData is set to True


Post /api/v3/report/exec/subscription

Operation: ProcessReportSubscriptionsV3 Permissions: Reports (Run)

Execute and email report subscriptions that are ready to be run


Post /api/v3/report/{specificReportId}/copy

Operation: CreateSpecificReportV3 Permissions: Reports (Run)

Save a specific report to Saved Reports


Post /api/v3/report/quick

Operation: RunQuickReportV3 Permissions: Reports (Run)

Generates a “quick report” in the specified export format (or in its preferred export format if not specified) as identified by the provided report code and applying ONLY the filters supplied.


Get /api/v3/report/{specificReportId}/share

Operation: GetReportSharingDetailsV3 Permissions: Reports (Run)

Get sharing information for a report


Put /api/v3/report/{specificReportId}/share

Operation: ShareSavedReportV3 Permissions: Reports (Run)

Share a saved report with other users


Put /api/v3/report/{specificReportId}/visible

Operation: ToggleSharedReportVisibilityV3 Permissions: Reports (Run)

Update the visibility of a report for the current user
This must be a report you can see
Which means you must have created the report
or have ReportAdministrator Manage permission and the report is shared at all
or have SharedReports View permission and the report is shared with you


Post /api/v3/report/{specificReportId}/subscription

Operation: CreateReportSubscriptionV3 Permissions: Reports (Run)

Subscribe to a report and receive scheduled emails
This must be a saved report that belongs to or is shared with the current user
Only SSRS reports are supported


Put /api/v3/report/{specificReportId}/subscription/{reportSubscriptionId}

Operation: EditReportSubscriptionV3 Permissions: Reports (Run)

Edit a report subscription
This must be a subscription that belongs to the current user


Delete /api/v3/report/{specificReportId}/subscription/{reportSubscriptionId}

Operation: DeleteReportSubscriptionV3 Permissions: Reports (Run)

Delete a report subscription
This must be a subscription that belongs to the current user


Get /api/v3/report/subscription/scheduletype

Operation: GetReportSubscriptionScheduleTypesV3 Permissions: Reports (Run)

Get a list of all available report subscription schedule types, and their day indicator values