API for Client Roaming Event Logs

[Mika Shimazaki]

https://documentation.meraki.com/MR/Monitoring_and_Reporting/Client_Roaming_Analytics

Meraki document explains that "Information in the Roaming Event Log is also available via API".

Could you please let me know the API document for client roaming event logs ?
My customer would like to create their dashboard app regarding client roaming event logs via Meraki API.

[Raphael_L]

Hi ,

I don't see that anywhere in the documentation and I can't find any endpoint that would return anything related to roams ☹️

[AidanKamp · Accepted solution]

Perhaps this endpoint?

https://developer.cisco.com/meraki/api-v1/get-network-wireless-client-connectivity-events/

I checked out an earlier roam in the UI:

This has a corresponding 'connection' type event with roam details, serial and MACs omitted:

    {
        "deviceSerial": "Q2XX-XXXX-XXXX",
        "band": "5",
        "ssidNumber": 4,
        "type": "connection",
        "subtype": "success",
        "occurredAt": "2025-03-03T20:13:38.345999Z",
        "severity": "good",
        "durationMs": 60,
        "channel": 48,
        "rssi": 36,
        "eventData": {
            "state": "11",
            "connAttempts": "3",
            "totalConnTime": "0.590",
            "reassoc": "1",
            "roamAp": "xx:xx:xx:xx:xx:xx",
            "roamApMac": "xx:xx:xx:xx:xx:xx"
        },
        "captureId": null
    }

roamAP corresponds with the BSSID of the source AP, roamApMac corresponds with the device MAC of the source AP, and deviceSerial corresponds to the target AP I roamed to.

[Raphael_L]

Hi ,

Might be a good idea to update the API doc to reflect the reality :

Maybe more user ( including myself ) would use some endpoints if we knew what they would return before trying them

[AidanKamp]

Where was this screenshot taken, @Raphletourn?

The bottom of this link has an example body that the API will return, as well as a schema:

https://developer.cisco.com/meraki/api-v1/get-network-wireless-client-connectivity-events/

[Raphael_L]

My bad , I was expecting the API index ( https://developer.cisco.com/meraki/api-v1/api-index/ ) to return something related to 'roam' but since the 'roam' is captured inside eventdata

"eventData": {
            "state": "11",
            "connAttempts": "3",
            "totalConnTime": "0.590",
            "reassoc": "1",
            "roamAp": "xx:xx:xx:xx:xx:xx",
            "roamApMac": "xx:xx:xx:xx:xx:xx"
        }

then it gets pretty hard to know what could eventData contain. I would have never figured that out without randomly trying the endpoint or reading this post.

[AidanKamp]

Thanks Raphael - my bad for missing that screenshot in the index.

It seems this endpoint is missing the keys nested inside eventData in the index as you've pointed out. Unsure if this is purposeful but I'll pass it on.

If I check a different endpoint as an example, e.g. getNetworkApplianceConnectivityMonitoringDestinations, the nested keys inside 'destinations' show in the response parameters:

Thanks for pointing that out.

[Raphael_L]

Great catch ! Thank you so much for following this up !

Cheers !

[wellyhartanto]

Hello,

This is related to what I'm currently doing.
I need to figure out the "bad roam" events, which I believe should be in the "subtype".
But I cannot find any documentation explaining what should be the expected values on "subtype".
Based on my tests so far, I can only see either null or "grabber".

Anyone can point me to the right direction?
Thanks!