Interface IOrganizationSensorReadingsLatest

Namespace

Meraki.Api.Interfaces.Products.Sensor

Assembly

Meraki.Api.dll

public interface IOrganizationSensorReadingsLatest

Methods

GetOrganizationSensorReadingsLatestAsync(string, int?, string?, string?, List<string>?, List<string>?, List<SensorMetrics>?, CancellationToken)

Return the latest available reading for each metric from each sensor, sorted by sensor serial

[Get("/organizations/{organizationId}/sensor/readings/latest")]
Task<List<SensorReadingLatest>> GetOrganizationSensorReadingsLatestAsync(string organizationId, int? perPage, string? startingAfter = null, string? endingBefore = null, List<string>? networkIds = null, List<string>? serials = null, List<SensorMetrics>? metrics = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id.

perPage int?

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

startingAfter string

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.

endingBefore string

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.

networkIds List<string>

Optional parameter to filter readings by network.

serials List<string>

Optional parameter to filter readings by sensor.

metrics List<SensorMetrics>

Types of sensor readings to retrieve. If no metrics are supplied, all available types of readings will be retrieved. Allowed values are temperature, humidity, water, door, tvoc, pm25, noise, indoorAirQuality, button, battery, downstreamPower, power, current, voltage, frequency and eco2.

cancellationToken CancellationToken

Returns

Task<List<SensorReadingLatest>>

Exceptions

ApiException

Thrown when fails to make API call