Sites Clients-Wireless

sitesClientsWireless := client.SitesClientsWireless()

Class Name

SitesClientsWireless

Methods

Count Site Wireless Client Events
Count Site Wireless Client Sessions
Count Site Wireless Clients
Get Site Events for Client
Get Site Wireless Client Stats
Get Site Wireless Clients Stats by Map
List Site Unconnected Client Stats
List Site Wireless Clients Stats
Search Site Wireless Client Events
Search Site Wireless Client Sessions
Search Site Wireless Clients

Count Site Wireless Client Events

Count by Distinct Attributes of Client-Events

CountSiteWirelessClientEvents(
    ctx context.Context,
    siteId uuid.UUID,
    distinct *models.SiteClientEventsCountDistinctEnum,
    mType *string,
    reasonCode *int,
    ssid *string,
    ap *string,
    proto *models.Dot11ProtoEnum,
    band *models.Dot11BandEnum,
    wlanId *string,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.RepsonseCount],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`distinct`	`*models.SiteClientEventsCountDistinctEnum`	Query, Optional	-
`mType`	`*string`	Query, Optional	see listDeviceEventsDefinitions
`reasonCode`	`*int`	Query, Optional	for assoc/disassoc events
`ssid`	`*string`	Query, Optional	SSID Name
`ap`	`*string`	Query, Optional	AP MAC
`proto`	`*models.Dot11ProtoEnum`	Query, Optional	a / b / g / n / ac / ax
`band`	`*models.Dot11BandEnum`	Query, Optional	802.11 Band
`wlanId`	`*string`	Query, Optional	wlan_id
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.RepsonseCount

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

distinct := models.SiteClientEventsCountDistinctEnum("type")















limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.CountSiteWirelessClientEvents(ctx, siteId, &distinct, nil, nil, nil, nil, nil, nil, nil, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "distinct": "string",
  "end": 0,
  "limit": 0,
  "results": [
    {
      "count": 0,
      "property": "string"
    }
  ],
  "start": 0,
  "total": 0
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Count Site Wireless Client Sessions

Count by Distinct Attributes of Client Sessions

CountSiteWirelessClientSessions(
    ctx context.Context,
    siteId uuid.UUID,
    distinct *models.SiteClientSessionsCountDistinctEnum,
    ap *string,
    band *models.Dot11BandEnum,
    clientFamily *string,
    clientManufacture *string,
    clientModel *string,
    clientOs *string,
    ssid *string,
    wlanId *string,
    page *int,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.RepsonseCount],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`distinct`	`*models.SiteClientSessionsCountDistinctEnum`	Query, Optional	-
`ap`	`*string`	Query, Optional	AP MAC
`band`	`*models.Dot11BandEnum`	Query, Optional	802.11 Band
`clientFamily`	`*string`	Query, Optional	E.g. “Mac”, “iPhone”, “Apple watch”
`clientManufacture`	`*string`	Query, Optional	E.g. “Apple”
`clientModel`	`*string`	Query, Optional	E.g. “8+”, “XS”
`clientOs`	`*string`	Query, Optional	E.g. “Mojave”, “Windows 10”, “Linux”
`ssid`	`*string`	Query, Optional	SSID
`wlanId`	`*string`	Query, Optional	wlan_id
`page`	`*int`	Query, Optional	-
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.RepsonseCount

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

distinct := models.SiteClientSessionsCountDistinctEnum("mac")

















page := 1

limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.CountSiteWirelessClientSessions(ctx, siteId, &distinct, nil, nil, nil, nil, nil, nil, nil, nil, &page, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "distinct": "string",
  "end": 0,
  "limit": 0,
  "results": [
    {
      "count": 0,
      "property": "string"
    }
  ],
  "start": 0,
  "total": 0
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Count Site Wireless Clients

Count by Distinct Attributes of Clients

CountSiteWirelessClients(
    ctx context.Context,
    siteId uuid.UUID,
    distinct *models.SiteClientsCountDistinctEnum,
    ssid *string,
    ap *string,
    ipAddress *string,
    vlan *string,
    hostname *string,
    os *string,
    model *string,
    device *string,
    page *int,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.RepsonseCount],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`distinct`	`*models.SiteClientsCountDistinctEnum`	Query, Optional	-
`ssid`	`*string`	Query, Optional	-
`ap`	`*string`	Query, Optional	-
`ipAddress`	`*string`	Query, Optional	-
`vlan`	`*string`	Query, Optional	-
`hostname`	`*string`	Query, Optional	-
`os`	`*string`	Query, Optional	-
`model`	`*string`	Query, Optional	-
`device`	`*string`	Query, Optional	-
`page`	`*int`	Query, Optional	-
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.RepsonseCount

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

distinct := models.SiteClientsCountDistinctEnum("hostname")





ipAddress := "192.168.1.1"











page := 1

limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.CountSiteWirelessClients(ctx, siteId, &distinct, nil, nil, &ipAddress, nil, nil, nil, nil, nil, &page, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "distinct": "string",
  "end": 0,
  "limit": 0,
  "results": [
    {
      "count": 0,
      "property": "string"
    }
  ],
  "start": 0,
  "total": 0
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Get Site Events for Client

Get the list of events for a specific client

GetSiteEventsForClient(
    ctx context.Context,
    siteId uuid.UUID,
    clientMac string,
    mType *string,
    proto *models.Dot11ProtoEnum,
    band *models.Dot11BandEnum,
    channel *string,
    wlanId *string,
    ssid *string,
    start *int,
    end *int,
    page *int,
    limit *int,
    duration *string) (
    models.ApiResponse[models.ResponseClientEventsSearch],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`clientMac`	`string`	Template, Required	-
`mType`	`*string`	Query, Optional	e.g. MARVIS_EVENT_CLIENT_DHCP_STUCK
`proto`	`*models.Dot11ProtoEnum`	Query, Optional	a / b / g / n / ac / ax
`band`	`*models.Dot11BandEnum`	Query, Optional	802.11 Band
`channel`	`*string`	Query, Optional	-
`wlanId`	`*string`	Query, Optional	-
`ssid`	`*string`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`page`	`*int`	Query, Optional	-
`limit`	`*int`	Query, Optional	-
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.ResponseClientEventsSearch

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

clientMac := "0000000000ab"

















page := 1

limit := 100

duration := "10m"

apiResponse, err := sitesClientsWireless.GetSiteEventsForClient(ctx, siteId, clientMac, nil, nil, nil, nil, nil, nil, nil, nil, &page, &limit, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "end": 1513176951,
  "limit": 10,
  "results": [
    {
      "ap": "5c5b350eb31b",
      "band": "5",
      "bssid": "5c5b350918f1",
      "channel": 149,
      "proto": "ac",
      "ssid": "Guest",
      "text": "Status code 0 \"Successful\"",
      "timestamp": 1513358874.667,
      "type": "CLIENT_DNS_OK",
      "type_code": 15,
      "wlan_id": "be22bba7-8e22-e1cf-5185-b880816fe2cf"
    }
  ],
  "start": 1512572151,
  "total": 1
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Get Site Wireless Client Stats

Get Site Client Stats Details

GetSiteWirelessClientStats(
    ctx context.Context,
    siteId uuid.UUID,
    clientMac string,
    wired *bool) (
    models.ApiResponse[[]models.StatsClientAnyOf],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`clientMac`	`string`	Template, Required	-
`wired`	`*bool`	Query, Optional	-

Response Type

[]models.StatsClientAnyOf

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

clientMac := "0000000000ab"

wired := false

apiResponse, err := sitesClientsWireless.GetSiteWirelessClientStats(ctx, siteId, clientMac, &wired)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    responseBody := apiResponse.Data
    for _, item := range responseBody {
        if i, ok := item.AsArrayOfClientWirelessStats(); ok {
            fmt.Println("Value narrowed down to []models.ClientWirelessStats: ", *i)
        } else if i, ok := item.AsStatsWiredClient(); ok {
            fmt.Println("Value narrowed down to models.StatsWiredClient: ", *i)
        }
    }

    fmt.Println(apiResponse.Response.StatusCode)
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Get Site Wireless Clients Stats by Map

Get Site Clients Stats By Map

GetSiteWirelessClientsStatsByMap(
    ctx context.Context,
    siteId uuid.UUID,
    mapId uuid.UUID,
    page *int,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[[][]models.ClientWirelessStats],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`mapId`	`uuid.UUID`	Template, Required	-
`page`	`*int`	Query, Optional	-
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

[][]models.ClientWirelessStats

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

mapId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

page := 1

limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.GetSiteWirelessClientsStatsByMap(ctx, siteId, mapId, &page, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

List Site Unconnected Client Stats

Get List of Site Unconnected Client Location

ListSiteUnconnectedClientStats(
    ctx context.Context,
    siteId uuid.UUID,
    mapId uuid.UUID) (
    models.ApiResponse[[]models.UnconnectedClientStat],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`mapId`	`uuid.UUID`	Template, Required	-

Response Type

[]models.UnconnectedClientStat

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

mapId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

apiResponse, err := sitesClientsWireless.ListSiteUnconnectedClientStats(ctx, siteId, mapId)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

[
  {
    "ap_mac": "5c5b350e0410",
    "last_seen": 1428939600,
    "mac": "5684dae9ac8b",
    "manufacture": "Apple",
    "rssi": -75,
    "x": 60,
    "y": 80
  }
]

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

List Site Wireless Clients Stats

Get List of Site All Clients Stats Details

ListSiteWirelessClientsStats(
    ctx context.Context,
    siteId uuid.UUID,
    wired *bool,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[[]models.StatsClientAnyOf],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`wired`	`*bool`	Query, Optional	-
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

[]models.StatsClientAnyOf

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

wired := false

limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.ListSiteWirelessClientsStats(ctx, siteId, &wired, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    responseBody := apiResponse.Data
    for _, item := range responseBody {
        if i, ok := item.AsArrayOfClientWirelessStats(); ok {
            fmt.Println("Value narrowed down to []models.ClientWirelessStats: ", *i)
        } else if i, ok := item.AsStatsWiredClient(); ok {
            fmt.Println("Value narrowed down to models.StatsWiredClient: ", *i)
        }
    }

    fmt.Println(apiResponse.Response.StatusCode)
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Search Site Wireless Client Events

Get Site Clients Events

SearchSiteWirelessClientEvents(
    ctx context.Context,
    siteId uuid.UUID,
    mType *string,
    reasonCode *int,
    ssid *string,
    ap *string,
    proto *models.Dot11ProtoEnum,
    band *models.Dot11BandEnum,
    wlanId *string,
    nacruleId *string,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.ResponseEventsSearch],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`mType`	`*string`	Query, Optional	see listDeviceEventsDefinitions
`reasonCode`	`*int`	Query, Optional	for assoc/disassoc events
`ssid`	`*string`	Query, Optional	SSID Name
`ap`	`*string`	Query, Optional	AP MAC
`proto`	`*models.Dot11ProtoEnum`	Query, Optional	a / b / g / n / ac / ax
`band`	`*models.Dot11BandEnum`	Query, Optional	802.11 Band
`wlanId`	`*string`	Query, Optional	wlan_id
`nacruleId`	`*string`	Query, Optional	nacrule_id
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.ResponseEventsSearch

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

















limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.SearchSiteWirelessClientEvents(ctx, siteId, nil, nil, nil, nil, nil, nil, nil, nil, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "end": 0,
  "limit": 0,
  "results": [
    {
      "ap": "string",
      "band": "24",
      "bssid": "string",
      "channel": 0,
      "proto": "a",
      "ssid": "string",
      "text": "string",
      "timestamp": 0,
      "type": "string",
      "type_code": 0,
      "wlan_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"
    }
  ],
  "start": 0,
  "total": 0
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Search Site Wireless Client Sessions

Search Client Sessions

SearchSiteWirelessClientSessions(
    ctx context.Context,
    siteId uuid.UUID,
    ap *string,
    band *models.Dot11BandEnum,
    clientFamily *string,
    clientManufacture *string,
    clientModel *string,
    clientUsername *string,
    clientOs *string,
    ssid *string,
    wlanId *string,
    pskId *uuid.UUID,
    pskName *string,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.ResponseClientSessionsSearch],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`ap`	`*string`	Query, Optional	AP MAC
`band`	`*models.Dot11BandEnum`	Query, Optional	802.11 Band
`clientFamily`	`*string`	Query, Optional	E.g. “Mac”, “iPhone”, “Apple watch”
`clientManufacture`	`*string`	Query, Optional	E.g. “Apple”
`clientModel`	`*string`	Query, Optional	E.g. “8+”, “XS”
`clientUsername`	`*string`	Query, Optional	Username
`clientOs`	`*string`	Query, Optional	E.g. “Mojave”, “Windows 10”, “Linux”
`ssid`	`*string`	Query, Optional	SSID
`wlanId`	`*string`	Query, Optional	wlan_id
`pskId`	`*uuid.UUID`	Query, Optional	PSK ID
`pskName`	`*string`	Query, Optional	PSK Name
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.ResponseClientSessionsSearch

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")



















pskId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")



limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.SearchSiteWirelessClientSessions(ctx, siteId, nil, nil, nil, nil, nil, nil, nil, nil, nil, &pskId, nil, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "end": 1513177200,
  "limit": 10,
  "results": [
    {
      "ap": "5c5b350e0262",
      "band": "5",
      "client_manufacture": "Apple",
      "connect": 1565208388,
      "disconnect": 1565208448,
      "duration": 60.09423865,
      "mac": "b019c66c8348",
      "org_id": "3139f2c2-fac6-11e5-8156-0242ac110006",
      "site_id": "70e0f468-fc13-11e5-85ad-0242ac110008",
      "ssid": "Dummy WLAN 2",
      "tags": [
        "disassociate"
      ],
      "timestamp": 1565208448.662,
      "wlan_id": "99bb4c74-f954-4f36-b844-6b030faffabc"
    }
  ],
  "start": 1511967600,
  "total": 100
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Search Site Wireless Clients

Search Wireless Clients

NOTE: fuzzy logic can be used with ‘’, supported filters: mac, hostname, device, os, model. E.g. /clients/search?device=Mac&hostname=jerry

SearchSiteWirelessClients(
    ctx context.Context,
    siteId uuid.UUID,
    mac *string,
    ipAddress *string,
    hostname *string,
    device *string,
    os *string,
    model *string,
    ap *string,
    ssid *string,
    text *string,
    nacruleId *string,
    limit *int,
    start *int,
    end *int,
    duration *string) (
    models.ApiResponse[models.ResponseClientSearch],
    error)

Parameters

Parameter	Type	Tags	Description
`siteId`	`uuid.UUID`	Template, Required	-
`mac`	`*string`	Query, Optional	partial / full MAC address
`ipAddress`	`*string`	Query, Optional	-
`hostname`	`*string`	Query, Optional	partial / full hostname
`device`	`*string`	Query, Optional	device type, e.g. Mac, Nvidia, iPhone
`os`	`*string`	Query, Optional	os, e.g. Sierra, Yosemite, Windows 10
`model`	`*string`	Query, Optional	model, e.g. “MBP 15 late 2013”, 6, 6s, “8+ GSM”
`ap`	`*string`	Query, Optional	AP mac where the client has connected to
`ssid`	`*string`	Query, Optional	-
`text`	`*string`	Query, Optional	partial / full MAC address, hostname, username, psk_name or ip
`nacruleId`	`*string`	Query, Optional	nacrule_id
`limit`	`*int`	Query, Optional	-
`start`	`*int`	Query, Optional	start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified
`end`	`*int`	Query, Optional	end datetime, can be epoch or relative time like -1d, -2h; now if not specified
`duration`	`*string`	Query, Optional	duration like 7d, 2w

Response Type

models.ResponseClientSearch

Example Usage

ctx := context.Background()

siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")



ipAddress := "192.168.1.1"

















limit := 100





duration := "10m"

apiResponse, err := sitesClientsWireless.SearchSiteWirelessClients(ctx, siteId, nil, &ipAddress, nil, nil, nil, nil, nil, nil, nil, nil, &limit, nil, nil, &duration)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "end": 17141231418.812,
  "limit": 118,
  "next": "next8",
  "results": [
    {
      "ap": [
        "a83a79a947ee",
        "003e73170b4c"
      ],
      "app_version": [
        "0.100.3"
      ],
      "band": "5",
      "device": [
        "Mac"
      ],
      "ftc": false,
      "hardware": "Apple Wi-Fi adapter",
      "hostname": [
        "hostname-a",
        "hostname-b"
      ],
      "ip": [
        "10.5.23.43",
        "192.168.0.2"
      ],
      "last_ap": "a83a79a947ee",
      "last_devuce": "Mac",
      "last_firmware": "wl0: Jan 20 2024 04:08:41 version 20.103.12.0.8.7.171 FWID 01-e09d2675",
      "last_hostname": "hostname-a",
      "last_ip": "10.5.23.43",
      "last_model": "MBP 16\\\" M1 2021",
      "last_os": "Sonoma",
      "last_os_version": "14.4.1 (Build 23E224)",
      "last_psk_id": "abf7dc5c-bb51-4bb7-93b6-5547400ffe11",
      "last_psk_name": "iot",
      "last_ssid": "IoT SSID",
      "last_username": "user@corp.com",
      "last_vlan": 10,
      "last_wlan_id": "e5d67b07-aae8-494b-8584-cbc20c8110aa",
      "mac": "bcd074000000",
      "mfg": "Apple",
      "model": "MBP 16\\\" M1 2021",
      "org_id": "1abff1aa-4571-4c1f-a409-153a1e7a7a24",
      "os": [
        "Sonoma"
      ],
      "os_version": [
        "14.4.1 (Build 23E224)"
      ],
      "protocol": "ax",
      "psk_id": [
        "abf7dc5c-bb51-4bb7-93b6-5547400ffe11"
      ],
      "psk_name": [
        "iot"
      ],
      "sdk_version": [
        "0.100.3"
      ],
      "site_id": "25ff5219-9be7-4db9-907d-0c9b60445147",
      "site_ids": [
        "25ff5219-9be7-4db9-907d-0c9b60445147"
      ],
      "ssid": [
        "IoT SSID"
      ],
      "timestamp": 1714124722.113,
      "username": [
        "user@corp.com"
      ],
      "vlan": [
        10
      ]
    }
  ],
  "start": 10,
  "total": 44
}

Errors

HTTP Status Code	Error Description	Exception Class
400	Bad Syntax	`ResponseHttp400Exception`
401	Unauthorized	`ResponseHttp400Exception`
403	Permission Denied	`ResponseHttp400Exception`
404	Not found. The API endpoint doesn’t exist or resource doesn’t exist	`ResponseHttp404Exception`
429	Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold	`ResponseHttp400Exception`

Files

sites-clients-wireless.md

Latest commit

History

sites-clients-wireless.md

File metadata and controls

Sites Clients-Wireless

Class Name

Methods

Count Site Wireless Client Events

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Count Site Wireless Client Sessions

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Count Site Wireless Clients

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Get Site Events for Client

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Get Site Wireless Client Stats

Parameters

Response Type

Example Usage

Errors

Get Site Wireless Clients Stats by Map

Parameters

Response Type

Example Usage

Errors

List Site Unconnected Client Stats

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

List Site Wireless Clients Stats

Parameters

Response Type

Example Usage

Errors

Search Site Wireless Client Events

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Search Site Wireless Client Sessions

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors

Search Site Wireless Clients

Parameters

Response Type

Example Usage

Example Response (as JSON)

Errors