Export (0) Print
Expand All

CsConference* reports

The CsConference* REST URIs provide summary statistics about the number of Office 365 Lync Online conferences. The number of conferences reported includes only those organized by a logged-in member of the tenant. There are three reports that use the same overall structure, and differ only in the time interval over which they summarize the data: daily, weekly, and monthly. For simplicity, the three reports are detailed in this one topic.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceMonthly[?ODATA options]

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

ApplicationSharingConferences

long

Edm.Int64

[In/Out] The number of application sharing conferences during the report period.

1042

2013-V1

AVConferences

long

Edm.Int64

[In/Out] The number AV conferences in the reporting.

Lync 2013

2013-V1

Date

System.DateTime

Edm.DateTime

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

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

2013-V1

ID

long

Edm.Int64

[In/Out] The index number of the report record.

72

2013-V1

IMConferences

long

Edm.Int64

The number of Instant Messaging conferences in the reporting period.

14

2013-V1

TelephonyConferences

long

Edm.Int64

The number of telephony conferences in the reporting period.

204

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 name of the organization.

example.onmicrosoft.com

2013-V1

TotalConferences

long

Edm.Int64

The number of conferences of all types in the reporting period.

12587

2013-V1

WebConferences

long

Edm.Int64

The number of web conferences in the reporting period.

5

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.

To be included in the reported numbers of conferences, at least one participant must have participated as their Office 365 organization user account.

Conference participants who were attending via mobile devices such as phones or tablets are not included in the report. For this reason, if all the participants in a conference use mobile devices, that conference won't show up in the report.

The conference counts returned include only conferences that were organized by a user of the organization. Each conference is only counted once per category, regardless of the number of users or guests that participate. Because different Lync Online plans might not include the ability to organize conferences, but may still have the ability to participate in them, the number of conferences organized within that tenant could feasibly always return zero.

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 three 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 as listed in the following table.

Report name

Time-period calculation

Daily (CsConferenceDaily)

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 (CsConferenceWeekly)

The reporting week starts at precisely midnight (00:00:00), early on Sunday, and ends just before midnight (23:59:59.9999...) on the following Saturday 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 (CsConferenceMonthly)

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.

The following request and response pair shows how to retrieve a report of conference activity by month in JSON format.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceMonthly?$format=Json
{
    "d":
      {
        "results":
          [
            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        CsConferenceMonthly(datetime'2013-05-31T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/
                        CsConferenceMonthly(datetime'2013-05-31T00%3A00%3A00')",
                    "type":"TenantReporting.CsConferenceReport"
                  },
                "ID":"24984",
                "Date":"\/Date(1369958400000)\/",
                "TenantGuid":"b4225608-d90a-4289-a458-bc69587bc613",
                "TenantName":"ExampleTenantName",
                "TotalConferences":"19",
                "AVConferences":"12",
                "IMConferences":"13",
                "ApplicationSharingConferences":"4",
                "WebConferences":"15",
                "TelephonyConferences":"0"
              }
          ]
      } 
  }

The following request and response pair shows how to retrieve the daily count of conferences (in reverse-chronological order), in Atom format. Because the report returns data for only the days when conferences actually occurred, when you request "N" entries using the $top option, the report returns the last N days that had conferences. This is not necessarily the same as getting the "previous N calendar days". Be aware that line breaks were added to the request and response for clarity.

https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceDaily?
    $select=Date,TotalConferences,AVConferences,IMConferences,ApplicationSharingConferences,WebConferences,TelephonyConferences&
    $top=10&
    $orderby=Date%20desc&
    $format=Atom
<?xml version="1.0" encoding="utf-8"?>
<feed xml:base="https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/" 
    xmlns="http://www.w3.org/2005/Atom" 
    xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" 
    xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsConferenceDaily</id>
  <title type="text">CsConferenceDaily</title>
  <updated>2013-07-08T20:48:10Z</updated>
  <link rel="self" title="CsConferenceDaily" href="CsConferenceDaily" />
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsConferenceDaily(datetime'2013-05-14T00%3A00%3A00')</id>
    <category term="TenantReporting.CsConferenceReport" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T20:48:10Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-14T00:00:00</d:Date>
        <d:TotalConferences m:type="Edm.Int64">6</d:TotalConferences>
        <d:AVConferences m:type="Edm.Int64">5</d:AVConferences>
        <d:IMConferences m:type="Edm.Int64">4</d:IMConferences>
        <d:ApplicationSharingConferences m:type="Edm.Int64">3</d:ApplicationSharingConferences>
        <d:WebConferences m:type="Edm.Int64">6</d:WebConferences>
        <d:TelephonyConferences m:type="Edm.Int64">0</d:TelephonyConferences>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsConferenceDaily
      (datetime'2013-05-13T00%3A00%3A00')</id>
    <category term="TenantReporting.CsConferenceReport" 
      scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T20:48:10Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-13T00:00:00</d:Date>
        <d:TotalConferences m:type="Edm.Int64">10</d:TotalConferences>
        <d:AVConferences m:type="Edm.Int64">7</d:AVConferences>
        <d:IMConferences m:type="Edm.Int64">6</d:IMConferences>
        <d:ApplicationSharingConferences m:type="Edm.Int64">1</d:ApplicationSharingConferences>
        <d:WebConferences m:type="Edm.Int64">8</d:WebConferences>
        <d:TelephonyConferences m:type="Edm.Int64">0</d:TelephonyConferences>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsConferenceDaily
      (datetime'2013-05-10T00%3A00%3A00')</id>
    <category term="TenantReporting.CsConferenceReport" 
      scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T20:48:10Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-10T00:00:00</d:Date>
        <d:TotalConferences m:type="Edm.Int64">3</d:TotalConferences>
        <d:AVConferences m:type="Edm.Int64">0</d:AVConferences>
        <d:IMConferences m:type="Edm.Int64">3</d:IMConferences>
        <d:ApplicationSharingConferences m:type="Edm.Int64">0</d:ApplicationSharingConferences>
        <d:WebConferences m:type="Edm.Int64">1</d:WebConferences>
        <d:TelephonyConferences m:type="Edm.Int64">0</d:TelephonyConferences>
      </m:properties>
    </content>
  </entry>
</feed>

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.

The CsConferenceDaily, CsConferenceWeekly, and CsConferenceMonthly reports were introduced in Office 365 service version 2013-V1. For more information about versioning, see Versioning in the Office 365 Reporting web service.

The CsConference* reports return the same information as the Get-CsConferenceReport Windows PowerShell cmdlet.

The account you access the reports from must have administrative permissions in that Office 365 organization. If the report is present in the service description document and the $metadata document returned to the user, then they have 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.

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.

Show:
© 2014 Microsoft