Get Average Session Lengths
CUSTOM-ENDPOINT
GET https://api.speakap.io/networks/:eid/stats/average-session-length
CUSTOM-REQUEST
- URI: /networks/{networkEID}/stats/average-session-length
- Method: GET
- Authentication: OAuth 2.0
Parameters
| Name | Type | Description |
|---|
| networkEID | EID | Network EID |
Filters
| Name | Type | Description |
|---|
| period | string | Date range for statistics. Possible values are: today, yesterday, last_7_days, last_week, last_30_days, last_month |
Parameter period equals to last_week will return data for last calendar week (from Monday to Sunday). Filter last_month has same behaviour.
Statistics Session Length Object
| Name | Type | Description |
|---|
| data | array | List of requested metrics. See concrete endpoints for exact values |
| dateFrom | datetime | Requested start date for statistics |
| dateTo | datetime | Requested end date for statistics |
| averageSessionLengthForPeriod | integer | Average session length per user per whole period |
Session Length Entry
| Name | Type | Description |
|---|
| date | datetime | Metrics date |
| averageSessionLength | integer | Average session length in seconds |
Response
| Status | Data |
|---|
| 200 | Valid: returns an Statistics Session Length Object with Session Length Entry objects under data key |
| 400 | Invalid request data: returns an Error object |
| 401 | Unauthorized: returns an Error object |