GET v1/accounts/{foreignaccountkey}/networks/{foreignkey}/analytics/clientsessions?from={from}&to={to}&timeZoneOffset={timeZoneOffset}

This resource returns the raw session data for the given time period<br/><br/> The properties returned can be as follows:-<br/> DeviceName: a string with a textual name for the device the session is attached to<br/> CLI: a string with a unique identifier for the device - e.g. its MSISDN<br/> StartTime: the UTC time the session started<br/> EndTime: the UTC time the session ended<br/> SessionEndCause: the reason the session terminated - one of:AccountingStop,AdminClear,UserDisabled,UserDeleted,DeviceDisabled,DeviceDeleted,SessionExpired,NewLogin,AuthentFailed,AuthorizeRejected,ASDiscoveryFailed,AccountDisabled,AccountDeleted,QuotaCutoffExceeded<br/> DataTx: bytes transmitted during the session<br/> DataRx: bytes received during the session<br/> MCC: Mobile country code the device connected from (if an APN based device and if the data is available)<br/> MNC: Mobile carrier code the device connected over (if an APN device and if the data is available)<br/> RestrictionCause: Indicates if a data control restriction has been placed on the device (only applicable if data controls are enabled and being used)<br/> RestrictionTime: The time the device was restricted<br/> DataAccessGroup: The data access group the device belongs to (only applicable if data controls are enabled)<br/> Zone:The zone (defined by a set of MCC,MNC pairs) the device connected in (only applicable if data controls are enabled)<br/>

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to query

string

Required

foreignkey

The network on the account to query

string

Required

from

The date and time to begin the report from e.g. '24aug2017 02:00'

date

None.

to

The date and time to end the report at e.g. '25aug2017 14:00'

date

None.

timeZoneOffset

The report time zone offset (as integer between -12 and 12, default is 0 (UTC)). 'from' and 'to' parameters are expected to be in the same time zone

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

A list of client session objects. Properties descried above

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.