ConnectionbyClientType* reports

  • Article

Important: These reports are deprecated as of January 29, 2018. We recommend that you use the Microsoft Graph Email app usage reports instead.

The ConnectionbyClientType* REST URIs provide summary statistics about the Office 365 Exchange Online connections made, organized by what kind of client application was used. There are four reports that use the same overall structure, and differ only in the time interval over which they summarize the data: daily, weekly, monthly, and yearly. For simplicity, the four reports are detailed together.

Applies to: Office 365

REST URIs

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeMonthly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeYearly[?ODATA options]

Fields

The following fields can be specified in $select, $filter, and $orderby ODATA2 query options. All fields are returned if no $select option is provided.

Name

WCF Type*

EDM Type*

[In/Out]** Description

Example values

Added in service version

Date

System.DateTime

Edm.DateTime

[In/Out] The end date and time of the reporting period. For more information about reporting periods, see the following sections.

Short Date (for example, 03/10/2013) or Date Time with quotes (for example, "03/10/2013 4:55 PM")

2013-V1

ClientType

string

Edm.String

[In/Out] The type of client application used to access Exchange Online.

Lync 2013

2013-V1

Count

long

Edm.Int64

[In/Out] The number of connections made by the client type during the report time period.

72

2013-V1

TenantGuid

System.guid

Edm.Guid

[In/Out] The GUID of the organization.

16a58f78-539f-47f7-b9bf-02a63867d73b

2013-V1

TenantName

string

Edm.String

[In/Out] The primary domain name of the organization.

example.onmicrosoft.com

2013-V1

*WCF Type refers to the .NET Framework data type assigned to the field when you create a Windows Communications Framework (WCF) Service Reference in Visual Studio. The EDM Type refers to the ADO.NET Entity Data Model (EDM) types returned in Atom-formatted reports.

**[In/Out]: For more information, see the Input parameters and report output columns section.

Remarks

Each entry in the report includes several fields of metadata. For more information, see Common metadata returned by the Office 365 Reporting web service.

The four report types differ only in the amount of time that each report entry covers. The time reported in the Date field represents the end of the time period. Dates and times are reported in the time zone specified in the HTTPS GET X-timezone header. If no time zone is specified, UTC time is used. The time durations reported are calculated in the following manner.

Report name

Time-period calculation

Daily (ConnectionbyClientTypeDaily)

The reporting day starts at precisely midnight (00:00:00) and ends just before midnight (23.59:59.9999...) on that same day. The last day reported will be the last full day for which data is available and will not include the current day. The date and time returned in the Date field represents the end of that reporting day.

Weekly (ConnectionbyClientTypeWeekly)

The reporting week starts at precisely midnight (00:00:00), early on Saturday, and ends just before midnight (23:59:59.9999...) on the following Friday night. The most-recently reported entry is the one that includes the current day and therefore will typically extend beyond when the report is requested. The date and time returned in the Date field represents the end of that reporting week.

Monthly (ConnectionbyClientTypeMonthly)

The reporting month starts at precisely midnight (00:00:00) on the first day of the month, and ends just before midnight (23.59:59.9999...) on the last calendar day of that month. The most-recently reported entry is the one that includes the current day, and therefore will typically extend beyond when the report is requested. The date and time returned in the Date field represents the end of that reporting month.

Yearly (ConnectionbyClientTypeYearly)

The reporting year starts at precisely midnight (00:00:00) on January 1 of that calendar year, and ends just before midnight (23.59:59.9999...) on December 31 of that same calendar year. The most-recently reported entry is the one that includes the current day, and therefore will typically extend beyond when the report is requested. The date and time returned in the Date field represents the end of that reporting month.

Examples

The following request and response pair demonstrates how to retrieve a report listing how many connections per month for each client type, in JSON format.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/ConnectionbyClientTypeMonthly?
    $select=Date,ClientType,Count&
    $format=Json

  {
    "d":
      {
        "results":
          [
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"MAPI",
                "Count":"0"
              },
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"POP3",
                "Count":"0"
              },
            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"IMAP",
                "Count":"0"
              },
            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"EAS",
                "Count":"0"
              },
            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"OWA",
                "Count":"0"
              },
            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        ConnectionbyClientTypeMonthly(datetime'2013-07-31T00%3A00%3A00')",
                    "type":"TenantReporting.ConnectionByClientTypeReport"
                  },
                "Date":"\/Date(1375228800000)\/",
                "ClientType":"EWS",
                "Count":"0"
              }
          ]
      }
  }

Input parameters and report output columns

The [In/Out] indicators in the fields table have the following meanings:

  • Fields marked [In] in the fields table are primarily intended for use in $filter=, $orderby= and other query options that restrict which entries the report returns. Fields marked [In] in the fields table can be included the $select= option, and they will appear in the report entries, but they will contain no useful data.

  • Fields marked [In/Out] in the fields table can be used in both column selection ($select=) and entry restriction ($filter= and $orderby=) options. When you include one of these fields in the $select= option, they will appear in the report entries, and will contain useful data when it is available.

Compatibility

The ConnectionbyClientTypeDaily, ConnectionbyClientTypeWeekly, ConnectionbyClientTypeMontly, and ConnectionbyClientTypeYearly reports were introduced in Office 365 service version 2013-V1. For more information about versioning, see Versioning in the Office 365 Reporting web service.

Corresponding PowerShell cmdlets

The ConnectionbyClientType* reports return the same information as the Get-ConnectionByClientTypeReport Windows PowerShell cmdlet.

Note

This cmdlet is deprecated. We don’t recommend that you use it in your production environment.

Permissions

The account you access the reports from must have administrative permissions in that Office 365 organization. If the account can view this report in the Office 365 control panel, then the account has permissions to retrieve the data from the REST web service. This report requires the user to be assigned to the View-Only Recipients Role. In the default Office 365 permissions structure, users with the following administrator permissions can access this report: billing administrator, global administrator, password administrator, service administrator, and user management administrator.

Data granularity, persistence, and availability

Information available through these reports can be separated into one-day periods, starting at midnight of the time zone reported by the calling application in the HTTP X-timezone header.

The information for this report is available for a period of one year, or until the subscription is cancelled.

Events may be delayed by up to 24 hours before they appear in a report.