Announcing the General Availability of Microsoft Setup Graph reporting APIs
General Availability of Microsoft Graph reporting APIs for retrieving Office 365 product usage data
The usage reports in the Office 365 admin center enable admins to understand their company’s usage across the Office 365 services. However, many of you have existing reporting solutions such as a company reporting application or a web portal in place. To assure that you can monitor your IT services in one unified location, the usage reporting APIs complement the usage reports and allow organizations and independent software vendors to incorporate Office 365 usage data into their existing reporting solutions. Using these APIs, you can retrieve the data available in all of the usage reports, including organization level summaries per service, entity level (user, sites, accounts) usage information for reporting periods of the last 7/30/90/180 days, and daily activity aggregates.
Get started with the new APIs
The new APIs are available now, and any user with global admin, product admin rights (for Exchange, Skype for Business and SharePoint), or a reports reader role can retrieve data through these APIs.
You can leverage the Microsoft Graph documentation for the reporting API and submit feature requests by asking or voting on an idea on UserVoice. Please submit questions by posting them on Stack Overflow and tagging microsoft graph.
With this announcement, we are announcing the deprecation of the following APIs within the Office 365 Reporting Web Service: ConnectionbyClientType, ConnectionbyClientTypeDetail, CsActiveUser, CsAVConferenceTime, CsP2PAVTime, CsConference, CsP2PSession, GroupActivity, MailboxActivity, GroupActivity, MailboxUsage, MailboxUsageDetail, StaleMailbox and StaleMailboxDetail.
We will remove these APIs, as well as any related PowerShell cmdlets, on January 29, 2018.
If you are currently using APIs or any of the related PowerShell cmdlets from the Office 365 Reporting Web Service, please start planning the migration of any subsystems within your organization. Below is a summary of the APIs and cmdlets that will be deprecated.
Office 365 Reporting web service
reference page
| Office 365 reporting-related
Windows PowerShell cmdlets
| Description | MS Graph Replacement |
CsActiveUser* reports | Get-CsAVConferenceTimeReport | The number of active, logged-in Lync Online users during the reporting period | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_act…
|
CsAVConferenceTime* reports | Get-CsActiveUserReport | The amount of time logged-in organization users participated in Lync Online conferences during the reporting period | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_org…
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_par…
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_pee…
|
CsP2PAVTime* reports | Get-CsP2PAVTimeReport | ||
CsConference* reports | Get-CsConferenceReport | The count of Lync Online conferences and peer-to-peer sessions during the reporting period. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_org…
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_par…
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/skype_for_business_pee…
|
CsP2PSession* reports | Get-CsP2PSessionReport | ||
ConnectionbyClientType* reports | Get-ConnectionByClientTypeReport | The number and types of email client-access methods used by the organization’s users during the reporting period. For example, Outlook Web Access, Exchange Web services, and so on. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/email_app_usage_report… |
ConnectionbyClientTypeDetail* reports | Get-ConnectionByClientTypeDetailReport | ||
GroupActivity* reports | Get-GroupActivityReport | Office 365user groups created and deleted, summarized over the indicated time periods. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/office_365_groups_acti…
|
MailboxActivity* reports
GroupActivity* reports
| Get-MailboxActivityReport
Get-GroupActivityReport
| Office 365users created and deleted, summarized over the indicated time periods. Active Directory Domain Services (AD DS) replication can sometimes delay this information up to a day. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/mailbox_usage_reports
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/office_365_groups_acti…
|
MailboxUsage report | Get-MailboxUsageReport | Summary and detailed statistics about organization user mailboxes. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/mailbox_usage_reports
|
MailboxUsageDetail report | Get-MailboxUsageDetailReport | ||
MailDetail report | Get-MailDetailReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailDetailDlpPolicy report | Get-MailDetailDlpPolicyReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailDetailMalware report | Get-MailDetailMalwareReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailDetailSpam report | Get-MailDetailSpamReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailDetailTransportRule report | Get-MailDetailTransportRuleReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailFilterList report | Get-MailFilterListReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailTraffic report | Get-MailTrafficReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailTrafficPolicy report | Get-MailTrafficPolicyReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailTrafficSummary reports | Get-MailTrafficSummaryReport | This method will continue to work as expected and is not impacted by this deprecation | |
MailTrafficTop report | Get-MailTrafficTopReport | This method will continue to work as expected and is not impacted by this deprecation | |
MessageTrace report | Get-MessageTrace | This method will continue to work as expected and is not impacted by this deprecation | |
MessageTraceDetail report | Get-MessageTraceDetail | This method will continue to work as expected and is not impacted by this deprecation | |
MxRecordReport report | Get-MxRecordReport | This method will continue to work as expected and is not impacted by this deprecation | |
OutboundConnectorReport report | Get-OutboundConnectorReport | This method will continue to work as expected and is not impacted by this deprecation | |
ServiceDeliveryReport report | Get-ServiceDeliveryReport | This method will continue to work as expected and is not impacted by this deprecation | |
Get-SPOActiveUserReport | View statistics about MicrosoftSharePoint Online users in your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getsharepointacti…
| |
Get-SPOSkyDriveProDeployedReport | View the number of My Site sites in your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getonedriveactivi…
| |
Get-SPOSkyDriveProStorageReport | View statistics about the space taken up (in MB) by My Sites in your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getonedriveusages…
| |
Get-SPOTeamSiteDeployedReport | View the number of My Site sites in your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getsharepointsite…
| |
Get-SPOTeamSiteStorageReport | View statistics about the space taken up (in MB) by team sites in your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getsharepointsite…
| |
Get-SPOTenantStorageMetricReport | View statistics about the space taken up (in MB) by all sites in for your cloud-based organization. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/reportroot_getsharepointsite…
| |
StaleMailbox report | Get-StaleMailboxReport | The details and summary counts of mailboxes that have not been accessed within the indicated time period. | This method is being deprecated as of January 29, 2018. It is replaced by the new MS Graph Reporting API available at
https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/email_activity_reports
|
StaleMailboxDetail report | Get-StaleMailboxDetailReport |
Comments
Post a Comment