Statistics

statsStats

stats(Object options, callback(ErrorInfo err, PaginatedResult<Stats> results))PaginatedResult<Stats> stats(Hash options)PaginatedResult<Stats> stats(kwargs_options)PaginatedResult<Stats> stats(Array options)PaginatedResult<Stats> stats(Param[] options)Task<PaginatedResult<Stats>> StatsAsync(StatsRequestParams query)stats(query: ARTStatsQuery?, callback: (ARTPaginatedResult#/realtime/types#paginated-result<ARTStats>?, ARTErrorInfo?) → Void) throws(c *RestClient) Stats(params *PaginateParams) (*PaginatedResult, error)

This call queries the Ably REST /stats API endpoint and retrieves your application’s usage statistics. A PaginatedResult is returned, containing an array of Stats for the first page of results. PaginatedResult objects are iterable providing a means to page through historical statistics. See an example set of raw stats returned via the REST API.

Parameters

optionsquery

an optional objectHashARTStatsQueryStatsRequestParamsParam[] array containing the query parameters

callback

is a function of the form: function(err, result)

&block

yields a PaginatedResult<Stats> object

callback

called with a ARTPaginatedResult<ARTStats> object or an error

options parametersARTStatsQuery propertiesStatsRequestParams properties

The following options, as defined in the REST /stats API endpoint, are permitted:

start:startStart

beginning of time earliest DateTimeOffset or Time or time in milliseconds since the epoch for any stats retrieved
Type: LongInt or @TimeDateTimeOffset

end:endEnd

current time latest DateTimeOffset or Time or time in milliseconds since the epoch for any stats retrieved
Type: LongInt or @TimeDateTimeOffset

direction:directionDirection

backwards :forwards or :backwards
Type: StringSymbolDirection enum

limit:limitLimit

100 maximum number of messages to retrieve up to 1,000
Type: Integer

unit:unitUnit

minute :minute, :hour, :day or :month. Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the query
Type: StringARTStatsGranularitySymbolStatsIntervalGranularity enum

Related types

Stats objectARTStatsio.ably.lib.types.StatsAbly::Models::StatsAbly\Models\StatsIO.Ably.Stats

A Stats object represents an application’s statistics for the specified interval and time period. Ably aggregates statistics globally for all accounts and applications, and makes these available both through our statistics API as well as your application dashboard.

Please note that most attributes of the Stats type below contain references to further stats types. This documentation is not exhaustive for all stats types, and as such, links to the stats types below will take you to the Ruby library stats documentation which contains exhaustive stats documentation. Ruby and Python however uses under_score case instead of the default camelCase in most languages, so please bear that in mind.

PropertiesMembersAttributesKeyword arguments

unit

the length of the interval that this statistic covers, such as :minute, :hour, :day, :monthMinute, Hour, Day, MonthStatGranularityDay, StatGranularityMonth'minute', 'hour', 'day', 'month'.
Type: Stats::GRANULARITYStatsIntervalGranularity enumARTStatsGranularityString

interval_granularityintervalGranularity

Deprecated alias for unit; scheduled to be removed in version 2.x client library versions.
Type: Stats::GRANULARITYStatsIntervalGranularity enumARTStatsGranularityString

intervalIdinterval_idIntervalId

the UTC time at which the time period covered by this Stats object starts. For example, an interval ID value of “2018-03-01:10” in a Stats object whose unit is day would indicate that the period covered is “2018-03-01:10 .. 2018-03-01:11”. All Stats objects, except those whose unit is minute, have an interval ID with resolution of one hour and the time period covered will always begin and end at a UTC hour boundary. For this reason it is not possible to infer the unit by looking at the resolution of the intervalId. Stats objects covering an individual minute will have an interval ID indicating that time; for example “2018-03-01:10:02”.
Type: String

interval_timeIntervalTime

A TimeDateTimeDateTimeOffset object representing the parsed intervalIdinterval_idIntervalId (the UTC time at which the time period covered by this Stats object starts)
Type: TimeDateTimeDateTimeOffset

allAll

aggregate count of both inbound and outbound message stats
Type: MessageTypes

apiRequestsapi_requestsApiRequests

breakdown of API requests received via the Ably REST API
Type: RequestCount

channelsChannels

breakdown of channel related stats such as min, mean and peak channels
Type: ResourceCount

connectionsConnections

breakdown of connection related stats such as min, mean and peak connections for TLS and non-TLS connections
Type: ConnectionTypes

inboundInbound

statistics such as count and data for all inbound messages received over REST and Realtime connections, organized into normal channel messages or presence messages
Type: MessageTraffic

outboundOutbound

statistics such as count and data for all outbound messages retrieved via REST history requests, received over Realtime connections, or pushed with Webhooks, organized into normal channel messages or presence messages
Type: MessageTraffic

persistedPersisted

messages persisted and later retrieved via the history API
Type: MessageTypes

tokenRequeststoken_requestsTokenRequests

breakdown of Ably Token requests received via the Ably REST API.
Type: RequestCount

pushPush

Detailed stats on push notifications, see our Push documentation for more details
Type: PushStats

IO.Ably.StatsRequestParams

ARTStatsGranularityIO.Ably.StatsGranularity

typedef NS_ENUM(NSUInteger, ARTStatsGranularity) {
    ARTStatsGranularityMinute,
    ARTStatsGranularityHour,
    ARTStatsGranularityDay,
    ARTStatsGranularityMonth
};

enum ARTStatsGranularity : UInt {
    case Minute
    case Hour
    case Day
    case Month
}

public enum StatsGranularity
{
    Minute,
    Hour,
    Day,
    Month
}

io.ably.lib.types.Param