Reporting

Reporting

Per-user login and reward activity for your users within a date range. For summarised statistics on logins, reward activity and impressions see Analytics.

HTTP Response Values

    200 - Successful call of the api
    400 - Invalid query string parameters
    401 - Missing, invalid or expired Bearer token

[GET] /v2/reports/users/activity?fromDate=2020-01-01&toDate=2020-01-31&page=0&size=10000

Name	Description
fromDate	(required) The start date of the report
toDate	(required) The end date of the report
page	(optional) Zero based page number. Defaults to 0
size	(optional) Page size. Defaults to 10000

Only users with at least one login in the date range are returned. Each user lists their logins and their reward activity within the date range.

A successful response looks like:

HTTP/1.1 200 Ok

{
  "data": [
    {
      "activity": [
        {
          "id": 0,
          "createdAt": "2020-01-01T10:15:00Z",
          "type": "Clicked Reward Tile",
          "userId": 0,
          "brandName": "string",
          "rewardTitle": "string"
        }
      ],
      "email": "string",
      "logins": [
        {
          "id": 0,
          "createdAt": "2020-01-01T10:00:00Z",
          "type": "Login",
          "userId": 0,
          "brandName": null,
          "rewardTitle": null
        }
      ],
      "userId": 0
    }
  ],
  "recordCount": 0,
  "pageTotal": 0,
  "currentPage": 0
}