Number of Users Active Within the Network
CUSTOM-ENDPOINT
GET https://api.speakap.io/networks/:eid/stats/active-users-count
CUSTOM-REQUEST
- URI: /networks/{networkEID}/stats/active-users-count
- 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.
Active Statistics 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 |
| uniqueUsersForPeriod | integer | Amount of unique users for requested period |
Response
| Status | Data |
|---|
| 200 | Valid: returns an Active Statistics Object with Users entry objects under data key |
| 400 | Invalid request data: returns an Error object |
| 401 | Unauthorized: returns an Error object |