GET /networks/{networkId}/clients

meraki.com

Summary: List the clients that have used this network in the timespan
Operation ID: getNetworkClients
Auth: unknown
Description

List the clients that have used this network in the timespan

Parameters (15)

description (string, query, optional)

Filters clients based on a partial or full match for the description field.

endingBefore (string, query, optional)

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

ip (string, query, optional)

Filters clients based on a partial or full match for the ip address field.

ip6 (string, query, optional)

Filters clients based on a partial or full match for the ip6 address field.

ip6Local (string, query, optional)

Filters clients based on a partial or full match for the ip6Local address field.

mac (string, query, optional)

Filters clients based on a partial or full match for the mac address field.

networkId (string, path, required)
os (string, query, optional)

Filters clients based on a partial or full match for the os (operating system) field.

perPage (integer, query, optional)

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10.

recentDeviceConnections (array, query, optional)

Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'.

startingAfter (string, query, optional)

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

statuses (array, query, optional)

Filters clients based on status. Can be one of 'Online' or 'Offline'.

t0 (string, query, optional)

The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

timespan (number, query, optional)

The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

vlan (string, query, optional)

Filters clients based on the full match for the VLAN field.

No probe data for this endpoint yet.