Click or drag to resize

IUsageReporting Interface

Public web service for usage reporting

Namespace:  Panopto.Server.Services.PublicAPI.V40
Assembly:  DataLib (in DataLib.dll) Version: 13.0.0.0 (13.0.0.00000)
Syntax
C#
public interface IUsageReporting

The IUsageReporting type exposes the following members.

Methods
  NameDescription
Public methodCancelReport
Cancel a pending one-time report, specified by reportId. To cancel a recurring report, use DeleteRecurringReport. This method is available in Panopto 7.0 and above.
Public methodCreateRecurringReport
Create a recurring report definition with the specified cadence at which to queue new reports. This method is available in Panopto 7.0 and above.
Public methodDeleteRecurringReport
Delete a recurring report definition with the specified id. This method is available in Panopto 7.0 and above.
Public methodDescribeReportType
Gets the localized column names of the specified reportType. This method is available in Panopto 5.7.0 and above.
Public methodDescribeReportTypes
Gets a list of the supported StatsReportTypes. This method is available in Panopto 5.7.0 and above.
Public methodGetFolderSummaryUsage
Gets a summary of usage on a folder. Must be an creator on the folder or an admin
Public methodGetQuizResultDownloadUrl
Get the download link for the quiz result report of a specific kind for a session. Must have analytics and quiz management permissions. This method is available in Panopto 8.0 and above.
Public methodGetRecentReports
Get the reports recently requested or processed by the caller, optionally filtered to a specified reportType. This method is available in Panopto 5.7.0 and above.
Public methodGetRecurringReports
Get all recurring report definitions and the reports recently generated by them, optionally filtered to a specified reportType. This method is available in Panopto 7.0 and above.
Public methodGetReport
Download a copy of the report, specified by reportId. This method does not return a standard SOAP response, and will instead return the contents of the report as an attachment. A sample of how to use this method can be found on our GitHub page at https://github.com/Panopto/UsageReportingDownloadsExample. This method is available in Panopto 5.7.0 and above.
Public methodGetSessionDetailedUsage
Gets detailed usage on a session. Includes which users viewed and when. Must be a creator on the session or an admin
Public methodGetSessionExtendedDetailedUsage
Gets extended detailed usage on a session. Includes views with details on playback state and seeking. Must have permission to view analyitcs on the session. This method is available in Panopto 6.0.0 and above.
Public methodGetSessionSummaryUsage
Gets a summary of usage on a session. Must be an creator on the session or an admin
Public methodGetSessionUserDetailedUsage
Gets detailed usage for a user about one session. Must be an admin or the user being queried for
Public methodGetSessionUserExtendedDetailedUsage
Gets extended detailed usage for a user about one session. Must be an admin or the user being queried for. This method is available in Panopto 6.0.0 and above.
Public methodGetSystemSummaryUsage
Gets a summary of all usage on the system. Must be an admin to call
Public methodGetUserDetailedUsage
Gets detailed usage for a user. Includes what the user viewed and when. Must be an admin or the user being queried for
Public methodGetUserExtendedDetailedUsage
Gets extended detailed usage for a user. Includes views with details on playback state and seeking. Must be an admin or the user being queried for. This method is available in Panopto 6.0.0 and above.
Public methodQueueReport
Request a report of the specified reportType covering the range in [startTime, endTime). This method is available in Panopto 5.7.0 and above.
Top
See Also