POST api/Management/SessionAnalytics

Request Information

URI Parameters

None.

Body Parameters

SessionAnalyticsRequestModel
NameDescriptionTypeAdditional information
FromDate

date

None.

ToDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "FromDate": "2026-03-21T11:23:34.5977488+00:00",
  "ToDate": "2026-03-21T11:23:34.5977488+00:00"
}

application/xml, text/xml

Sample:
<SessionAnalyticsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Business.Models">
  <FromDate>2026-03-21T11:23:34.5977488+00:00</FromDate>
  <ToDate>2026-03-21T11:23:34.5977488+00:00</ToDate>
</SessionAnalyticsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SessionAnalyticsModel
NameDescriptionTypeAdditional information
FromDate

date

None.

ToDate

date

None.

ChurnRate

decimal number

None.

NoOfUsers

integer

None.

NoOfSessions

integer

None.

NoOfUsersNotReturning

integer

None.

NoOfChangedIncidents

integer

None.

AvgSessionLengthSeconds

decimal number

None.

AvgSessionInterval

decimal number

None.

AreasUsed

Collection of AnalyticsAreasUsed

None.

GeosUsed

Collection of AnalyticsGeoMetrics

None.

Response Formats

application/json, text/json

Sample:
{
  "FromDate": "2026-03-21T11:23:34.5977488+00:00",
  "ToDate": "2026-03-21T11:23:34.5977488+00:00",
  "ChurnRate": 3.1,
  "NoOfUsers": 4,
  "NoOfSessions": 5,
  "NoOfUsersNotReturning": 6,
  "NoOfChangedIncidents": 7,
  "AvgSessionLengthSeconds": 8.1,
  "AvgSessionInterval": 9.1,
  "AreasUsed": [
    {
      "Screen": "sample string 1",
      "Action": "sample string 2",
      "Count": 3
    },
    {
      "Screen": "sample string 1",
      "Action": "sample string 2",
      "Count": 3
    }
  ],
  "GeosUsed": [
    {
      "HomeTown": "sample string 1",
      "Count": 2
    },
    {
      "HomeTown": "sample string 1",
      "Count": 2
    }
  ]
}

application/xml, text/xml

Sample:
<SessionAnalyticsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Business.Models">
  <AreasUsed>
    <AnalyticsAreasUsed>
      <Action>sample string 2</Action>
      <Count>3</Count>
      <Screen>sample string 1</Screen>
    </AnalyticsAreasUsed>
    <AnalyticsAreasUsed>
      <Action>sample string 2</Action>
      <Count>3</Count>
      <Screen>sample string 1</Screen>
    </AnalyticsAreasUsed>
  </AreasUsed>
  <AvgSessionInterval>9.1</AvgSessionInterval>
  <AvgSessionLengthSeconds>8.1</AvgSessionLengthSeconds>
  <ChurnRate>3.1</ChurnRate>
  <FromDate>2026-03-21T11:23:34.5977488+00:00</FromDate>
  <GeosUsed>
    <AnalyticsGeoMetrics>
      <Count>2</Count>
      <HomeTown>sample string 1</HomeTown>
    </AnalyticsGeoMetrics>
    <AnalyticsGeoMetrics>
      <Count>2</Count>
      <HomeTown>sample string 1</HomeTown>
    </AnalyticsGeoMetrics>
  </GeosUsed>
  <NoOfChangedIncidents>7</NoOfChangedIncidents>
  <NoOfSessions>5</NoOfSessions>
  <NoOfUsers>4</NoOfUsers>
  <NoOfUsersNotReturning>6</NoOfUsersNotReturning>
  <ToDate>2026-03-21T11:23:34.5977488+00:00</ToDate>
</SessionAnalyticsModel>