Returns a site-level summary report of WSAT usage for a GSM master keycode by a site keycode. The report includes information like the site name and license type as well as the total number of users.
GET {{baseUrl}}/api/status/reporting/gsm/:gsmKey/sites/:keyCode/wsat?reportType=UsersSeenInLast30Days&effectiveDate=2022-11-24T00:00:00Z
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
reportType | string | The type of report to be produced. The following values are supported: |
- "UsersSeen": Provides WSAT statistics for all users seen on the effective report date.
- "UsersSeenInLast30Days": Provides WSAT statistics for all users seen in the last 30 days (between the effective report date and 30 days earlier).
If omitted, the reportType is set to "UsersSeenInLast30Days". |
| effectiveDate | string | | The date the report should refer to. If omitted, the most recent usage report will be returned.
Note: Usage data will typically be generated in the course of the following day (UTC) and therefore can only be provided for dates earlier than yesterday. If, for example, this API method is called at 11:00 pm UTC, yesterday's data will not be available yet. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"ReportInfo":{"Count":1,"SiteKeyFilter":null,"ReportType":"UsersSeen","EffectiveDate":"2022-11-15T00:00:00Z","GSMKey":"082h4oymi8x1jn4ium67"},"Sites":[{"SiteId":"6a5fa841-79c3-556e-02fd-58a78e3a44e5","SiteKey":"qvmu0ef1mptrmcqshdei","SiteName":"Site 0WLOTU9L9J","SiteLicenseType":"Full","SiteExpiryDate":"2024-12-30T01:26:02.6691685Z","SiteState":"active","SiteStateChangedDate":"2022-11-16T10:36:02.6691685Z","WSATEnabled":true,"WSATLicenseType":"Trial","WSATExpiryDate":"2025-08-11T06:03:02.6691685Z","TotalWSATUsers":78}]}