Export (0) Print
Expand All

CsAVConferenceTime* reports

The CsAVConferenceTime* REST URIs provide summary statistics about the amount of time that logged-in users spent in Office 365 Lync Online conferences that included audio or video. 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/CsAVConferenceTimeDaily[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsAVConferenceTimeWeekly[?ODATA options]
https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsAVConferenceTimeMonthly[?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

AVConferenceMinutes

long

Edm.Int64

[In/Out] The number of minutes spent in AV conferences in the reporting period that ends on the Date value.

3330

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

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

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.

To be included in the reported conference resources used, 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 reported time tallies. 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 who 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 in the following manner.

Report name

Time-period calculation

Daily (CsAVConferenceTimeDaily)

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

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

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 demonstrates how to retrieve a report of AV conference activity by month in JSON format. The query $select option requests just the Date and number of minutes. Be aware that only one report data point was returned, for May 1st, 2013.

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

  {
    "d":
      {
        "results":
          [            
              {
                "__metadata":
                  {
                    "id":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeMonthly
                        (datetime'2013-05-01T00%3A00%3A00')",
                    "uri":"https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeMonthly
                        (datetime'2013-05-01T00%3A00%3A00')",
                    "type":"TenantReporting.CsAVConferenceTimeReport"
                  },
                "Date":"\/Date(1367366400000)\/",
                "AVConferenceMinutes":"37"
              }            
          ]        
      }    
  }

The following request and response pair demonstrates how to retrieve the daily count of AV Conference minutes used, for the previous 14 days, in reverse-chronological order. Like the previous query, this one requests only the Date and AVConferenceMinutes count, and requests the information in Atom format. The report returns an entry for each day that contains data, so in this case the $top restriction applies to the last 14 "days that have data", which is not necessarily the same as the last 14 calendar days. To restrict the reporting period to a specific time, use the $filter query option. Be aware that line breaks were added to the request and response for clarity.


https://reports.office365.com/ecp/reportingwebservice/reporting.svc/CsAVConferenceTimeDaily?
  $select=Date,TenantName,AVConferenceMinutes&
  $filter=Date%20ge%20datetime'2013-01-01T00:00:00'%20and%20
    Date%20lt%20datetime'2013-06-26T00:00:00'&
  $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/CsAVConferenceTimeDaily</id>
  <title type="text">CsAVConferenceTimeDaily</title>
  <updated>2013-07-08T23:41:28Z</updated>
  <link rel="self" title="CsAVConferenceTimeDaily" href="CsAVConferenceTimeDaily" />
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeDaily
        (datetime'2013-05-14T00%3A00%3A00')</id>
    <category term="TenantReporting.CsAVConferenceTimeReport" 
        scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T23:41:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-14T00:00:00</d:Date>
        <d:AVConferenceMinutes m:type="Edm.Int64">13</d:AVConferenceMinutes>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeDaily
        (datetime'2013-05-13T00%3A00%3A00')</id>
    <category term="TenantReporting.CsAVConferenceTimeReport" 
        scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T23:41:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-13T00:00:00</d:Date>
        <d:AVConferenceMinutes m:type="Edm.Int64">24</d:AVConferenceMinutes>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeDaily
        (datetime'2013-05-10T00%3A00%3A00')</id>
    <category term="TenantReporting.CsAVConferenceTimeReport" 
        scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T23:41:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-10T00:00:00</d:Date>
        <d:AVConferenceMinutes m:type="Edm.Int64">93</d:AVConferenceMinutes>
      </m:properties>
    </content>
  </entry>
  <entry>
    <id>https://reports.office365.com/ecp/ReportingWebService/Reporting.svc/CsAVConferenceTimeDaily
        (datetime'2013-05-05T00%3A00%3A00')</id>
    <category term="TenantReporting.CsAVConferenceTimeReport" 
        scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title />
    <updated>2013-07-08T23:41:28Z</updated>
    <author>
      <name />
    </author>
    <content type="application/xml">
      <m:properties>
        <d:Date m:type="Edm.DateTime">2013-05-05T00:00:00</d:Date>
        <d:AVConferenceMinutes m:type="Edm.Int64">165</d:AVConferenceMinutes>
      </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 CsAVConferenceTimeDaily, CsAVConferenceTimeWeekly, and CsAVConferenceTimeMonthly 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 CsAVConferenceTime* reports return the same information as the Get-CsAVConferenceTimeReport 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.

Community Additions

ADD
Show:
© 2014 Microsoft