Cisco CMX Cloud Application APIs – Cisco CMX

CMXCloud is a great way to start using CMX with very little overhead.

However, the reports may not provide exactly what you are looking for, as an alternative, you can use the APIs.

Here is the quick start guide for using the API.

First you should login into cmxcisco.com and your site.

Once you have logged in with a different Chrome TAB, your browser will give you the authentication token required to get the SITEID.

Then use this API to get the site ID.

https://<tenant-id>.cmxcisco.com/api/config/v1/sites

Here is the output you will get….

[{"changedOn":0,"aesUId":1487056035936,"name":"PSL NOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":3,"timezone":"Asia/Kolkata","aesUidString":"1487056035936","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb 28, 2017 3:37:50 PM","objectVersion":0},{"changedOn":0,"aesUId":1487260407843,"name":"NOC","description":null,"aps":[],"rssiThresholdLow":-95,"rssiThresholdHigh":-65,"examinePeriod":900000,"minDuration":300000,"tags":null,"apCount":1,"timezone":"Asia/Kolkata","aesUidString":"1487260407843","tagList":null,"address":"Nagpur","latitude":0.0,"longitude":0.0,"applyExclusion":false,"exclusionParams":null,"currentTime":"Feb 28, 2017 3:37:50 PM","objectVersion":0}]

The aesUId is the SITEID that you should use...

https://<tenant-id>.cmxcisco.com/api/presence/v1/connected/count/yesterday?siteId=<SITEID>

(Note: Make sure you use siteId (case is important). siteid or siteID will NOT work.

Use siteId=XXXX..

This gives you the data you requested:

1334

You can see how this matches what is shown on the GUI…(ie Total Connected = 1334)

To get a full list of the ANALYTICS API that are usable, you can look at the following sandbox instances.

https://www.cisco.com/c/en/us/td/docs/wireless/mse/cmxcloud/api/b_cmxcloud_api_reference/b-cmx-102-api-reference-guide_chapter_0100.htmlhttps://msesandbox.cisco.com:8081/apidocs/presence-api

Generally, there are seven types of APIs.

Connect API are used to get information about the clients that have used the CONNECT Splash page.

https://<TOPLEVELDOMAIN>.cmxcisco.com/api/connect/v1/clients?siteId=XXXXXXX

Cisco CMX Location APIs are not supported on Cisco CMX Cloud.

Comments

3 comments

Darryl Sladden (dsladden)

December 16, 2016 22:34
Updated
0

Seva Tsurikov

August 03, 2017 18:30
Link to https://msesandbox.cisco.com:8081/apidocs/presence-api does not work.
Please explain how to get <TOPLEVELDOMAIN> from the last example.
0

Frank Mittrup

August 03, 2016 13:27
The document is a one pager and looks to me that content is missing. Could this be the case?
0

Please sign in to leave a comment.

Articles in this section

Related articles