Metrics and Reporting

The Cisco Spark API includes several reports which can be used by administrators to gather usage and quality information about their organization's usage of Spark.

Information Available

The following reports are available via the Metrics API.

Requirements

  • The Metrics API feature must be enabled for an organization before metrics and statistics information will be available via the API.

Metric Reporting Windows

The Metrics API will return data for the time interval specified in the request. There are three reporting windows available: daily, weekly, and monthly.

Daily reporting windows will include metrics for a single day, as specified by the startDate parameter. To specify the number of consecutive days to return, use the numberOfIntervals parameter. For example, requesting daily metrics starting on 2017-03-14 for one interval will return one result for 2017-03-14. Requesting daily metrics starting on 2017-03-14 for seven intervals will return seven results, one for each day between 2017-03-14 and 2017-03-20.

Weekly and Monthly reporting windows are not aligned with calendar weeks or months—they are seven day or thirty day reporting windows which begin with the startDate provided in the request.

For weekly reporting windows, the reporting data will be aggregated into seven day periods, starting on the startDate specified. For example, requesting weekly metrics starting on 2017-03-14 for one interval will return one result for the aggregate data between 2017-03-14 and 2017-03-20.

For monthly reporting windows, the reporting data will be aggregated into thirty day periods, starting on the startDate specified. For example, requesting monthly metrics starting on 2017-03-14 for two intervals will return two results, one for the aggregate period between 2017-03-14 and 2017-04-13, and a second result for the aggregate data for 2017-04-14 and 2017-05-13.

See the following table for example reporting windows:

intervalType startDate numberOfIntervals Data Returned
daily 2017-03-14 00:00:00.000Z 1 1 Record:
  • Data for 2017-03-14
daily 2017-03-14 00:00:00.000Z 4 4 Records:
  • Data for 2017-03-14
  • Data for 2017-03-15
  • Data for 2017-03-16
  • Data for 2017-03-17
weekly 2017-03-13 00:00:00.000Z 1 1 Records:
  • Data for 2017-03-13 through 2017-03-19
weekly 2017-03-14 00:00:00.000Z 1 1 Records:
  • Data for 2017-03-14 through 2017-03-20
weekly 2017-03-14 00:00:00.000Z 3 3 Records:
  • Data for 2017-03-14 through 2017-03-20
  • Data for 2017-03-21 through 2017-03-27
  • Data for 2017-03-28 through 2017-04-03
monthly 2017-03-14 00:00:00.000Z 1 3 Records:
  • Data for 2017-03-14 through 2017-04-13
monthly 2017-03-17 00:00:00.000Z 3 3 Records:
  • Data for 2017-03-17 through 2017-04-15
  • Data for 2017-04-16 through 2017-05-15
  • Data for 2017-05-16 through 2017-06-14

REST API Reference

For detailed information about the metric reports available, see the Metrics API Reference.