Get Message Metrics

This report will contain aggregate messaging data for an organization that is using Cisco Spark.

The data intervals specified in the query will change the reporting windows and time frame. This report will default to seven days of data (numberOfIntervals=7), with metrics grouped daily (intervalType=daily), if these two parameters are not specified.

m
You're not logged in. to run the demo.
get
https://api.ciscospark.com/v1/metrics/adhoc?report=message

Request Headers

Content-type application/json; charset=utf-8
Authorization
Bearer

Query Parameters

Name Type Description
orgId string

Organization to use for report.

startDate string

Start date of the reporting interval.

Format: YYYY-MM-dd HH:mm:ss

numberOfIntervals integer

Number of reporting intervals to include.

intervalType string

Type of reporting interval to use. Group results by day, week, or month.

Possible values: daily, weekly, monthly

page integer

Which page of the result set to fetch.

Query Parameters

Name Type Your values
orgId string
startDate string
numberOfIntervals integer
intervalType string
page integer

Response Codes

200

OK

400

The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

401

Authentication credentials were missing or incorrect.

403

The request is understood, but it has been refused or access is not allowed.

404

The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.

409

The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.

429

Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.

500

Something went wrong on the server.

503

Server is overloaded with requests. Try again later.