Cisco CMX API

Cisco CMX API

The Cisco Connected Mobile Experiences (CMX) API is designed to provide programmatic access to location and visitor data collected via Cisco wireless infrastructure. It enables developers to configure CMX, retrieve real-time location information, analytics, presence data, and user session details. The API facilitates the creation of applications that leverage Wi-Fi-based location intelligence to enhance customer experiences and venue operations.

The API is RESTful and supports standard HTTP methods (GET, PUT, POST, DELETE). It is also supported by Cisco DevNet, where developers can find resources and community support for building on CMX APIs.

The primary users are network administrators, developers, integrators, and partners who want to build applications or integrations that leverage CMX data and services. It is aimed at those who need to programmatically interact with CMX for configuration, analytics, and location services.

It solves the challenge of accessing and utilizing location-based data and analytics in a standardized, scalable way. It allows businesses to deliver personalized content, improve space utilization, and gain insights into visitor behavior without manual intervention.

Use cases
  • Retail and Venue Analytics: Tracking visitor movement and dwell times to optimize layouts and marketing.

  • Personalized Customer Engagement: Delivering location-based promotions and notifications to mobile devices.

  • Space Utilization: Monitoring occupancy and usage patterns in buildings or campuses.

  • Asset Tracking: Locating devices or assets within a Wi-Fi environment.

  • User Session Management: Managing and analyzing user sessions for network access and engagement.

API field updates

This summary highlights the key changes that may impact compatibility and integration between the two Cisco CMX API versions. Between API versions 10.6.3 and 11.0.0, a total of 55 fields were identified with changes.

Of these, two fields showed a Difference in Value (Conversion error), indicating potential discrepancies during data conversion, while 53 fields were marked as Removed from release 11.x.x, suggesting they are absent in the latest API version’s output.

Table 1. Field updates

Fields

Release 10.6.3

Release 11.x.x

Data Type

affectedBand

Null

Removed from release 11.x.x

Not applicable

affectedChannels

Null

Removed from release 11.x.x

Not applicable

areaGlobalidList

Not Null

Removed from release 11.x.x

Array

bleTagInfo

Null

Removed from release 11.x.x

Not applicable

bssid

Null

Removed from release 11.x.x

Not applicable

bytesReceived

0

Removed from release 11.x.x

Not applicable

bytesSent

0

Removed from release 11.x.x

Not applicable

classification

Null

Removed from release 11.x.x

Not applicable

classifiedByAP

Empty

Removed from release 11.x.x

Not applicable

classifiedRSSI

0

Removed from release 11.x.x

Not applicable

className

Empty

Removed from release 11.x.x

Not applicable

clientMacs

Null

Removed from release 11.x.x

Not applicable

containmentLevel

Null

Removed from release 11.x.x

Not applicable

controllerClusterMac

Null

Removed from release 11.x.x

Not applicable

currentlyTracked

Not Null

Removed from release 11.x.x

Not applicable

detectingControllers

Not Null

Removed from release 11.x.x

Not applicable

deviceKey

Null

Removed from release 11.x.x

Not applicable

deviceType

Null

Removed from release 11.x.x

Not applicable

dot11Status

Not Null

Removed from release 11.x.x

Not applicable

dutyCycle

0

Removed from release 11.x.x

Not applicable

floorId

Not Null

Difference in Value (Conversion error)

Not applicable

guestUser

Not Null

Removed from release 11.x.x

Not applicable

gwMacAddr

Null

Removed from release 11.x.x

Not applicable

hiddenSSID

0

Removed from release 11.x.x

Not applicable

hierarchyDetails.id

Not Null

Difference in Value (Conversion error)

Not applicable

hierarchyDetails.zones

Null

Removed from release 11.x.x

Not applicable

ipAddress

Not Null

Removed from release 11.x.x

Not applicable

lastUpdated

Null

Removed from release 11.x.x

Not applicable

macAddress

Not Null

Removed from release 11.x.x

Not applicable

mapInfo

Not Null

Removed from release 11.x.x

Not applicable

maxDetectingAPMacAddress

Null

Removed from release 11.x.x

Not applicable

maxRssiRadioType

0

Removed from release 11.x.x

Not applicable

networkStatus

Not Null

Removed from release 11.x.x

Not applicable

notificationTime

Not Null

Removed from release 11.x.x

Not applicable

numOfDetectingAPs

0

Removed from release 11.x.x

Not applicable

rogueClChBy

Null

Removed from release 11.x.x

Not applicable

rogueStChBy

Null

Removed from release 11.x.x

Not applicable

rssiEntries

Not Null

Removed from release 11.x.x

Array

severity

0

Removed from release 11.x.x

Not applicable

severityCategory

Null

Removed from release 11.x.x

Not applicable

sourceNotification

Not Null

Removed from release 11.x.x

Not applicable

sourceNotificationKey

Not Null

Removed from release 11.x.x

Not applicable

state

Null

Removed from release 11.x.x

Not applicable

statistics

Not Null

Removed from release 11.x.x

Object of JSON

subscriptionName

Not Null

Removed from release 11.x.x

Not applicable

switchPortShutdown

Not Null

Removed from release 11.x.x

Not applicable

tagBatteryInfo

Null

Removed from release 11.x.x

Not applicable

tagLastBeaconSequenceNumber

0

Removed from release 11.x.x

Not applicable

tagLastBeaconTime

Null

Removed from release 11.x.x

Not applicable

tagTelemetryList

Null

Removed from release 11.x.x

Not applicable

tagVendorData

Null

Removed from release 11.x.x

Not applicable

totalClients

0

Removed from release 11.x.x

Not applicable

tracedWiredRogue

Not Null

Removed from release 11.x.x

Not applicable

type

Null

Removed from release 11.x.x

Not applicable

zoneOfImpact

0

Removed from release 11.x.x

Not applicable