Developers
V1PlatformAnalytics

App registrations, consented activity, welcome, rewards and merchant metrics

Choose days=7|30|90, a calendar preset, or inclusive MYT from/to dates (maximum 366 days). Future selection ends no later than next month; completed activity is clipped to now. Current totals and DAU/WAU/MAU remain anchored to the snapshot. App activity requires current consent and is available only within retained collection coverage (90 calendar days), never backfilled. Registrations exclude deleted and pending-deletion accounts. Welcome and reward outcomes use sessions/claims started in the selected period. No identities, individual answers, health records or contacts. At most 20 version and merchant breakdown rows; total counts identify truncation. Requires a fresh password session and live platform role.

GET
/v1/platform/analytics
AuthorizationBearer <token>

In: header

Query Parameters

days?|

Legacy 7, 30 or 90 Malaysia dates including today. No selection defaults to 30. Mutually exclusive with preset/from/to.

preset?string

Named MYT period; weeks start Monday. Mutually exclusive with days/from/to.

Value in

  • "today"
  • "yesterday"
  • "this_week"
  • "last_week"
  • "this_month"
  • "last_month"
  • "last_7_days"
  • "last_30_days"
  • "last_90_days"
  • "next_week"
from?string

Inclusive first MYT date; requires to. Custom ranges allow at most 366 dates.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to?string

Inclusive last MYT date; requires from. Cannot extend past next month's final date.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/platform/analytics"
{  "generatedAt": "2019-08-24T14:15:22Z",  "window": {    "days": 1,    "start": "2019-08-24T14:15:22Z",    "end": "2019-08-24T14:15:22Z",    "timezone": "Asia/Kuala_Lumpur",    "firstDay": "2019-08-24",    "lastDay": "2019-08-24"  },  "app": {    "registrations": {      "total": 0,      "inPeriod": 0,      "today": 0,      "firstRegisteredAt": "2019-08-24T14:15:22Z"    },    "activity": {      "dau": 0,      "wau": 0,      "mau": 0,      "inPeriod": 0,      "newInPeriod": 0,      "returningInPeriod": 0,      "consentedAccounts": 0,      "collectionStartedAt": "2019-08-24T14:15:22Z",      "coverage": {        "status": "available",        "firstAvailableDay": "2019-08-24",        "lastAvailableDay": "2019-08-24"      }    }  },  "welcome": {    "started": 0,    "completed": 0,    "inProgress": 0,    "skipped": 0,    "versionsTotal": 0,    "versions": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "status": "draft",        "started": 0,        "completed": 0,        "inProgress": 0,        "skipped": 0,        "slides": [          {            "id": "string",            "title": "string",            "seen": 0          }        ]      }    ]  },  "rewards": {    "claims": 0,    "redeemed": 0,    "reserved": 0,    "expired": 0,    "cancelled": 0,    "current": {      "publishedOffers": 0,      "claimableOffers": 0,      "submittedOffers": 0,      "stockTotal": 0,      "redeemed": 0,      "reserved": 0,      "available": 0    }  },  "merchants": {    "added": 0,    "ownerInvitations": 0,    "ownerAcceptances": 0,    "current": {      "total": 0,      "prospect": 0,      "invited": 0,      "active": 0,      "suspended": 0,      "pilotLimit": 5    },    "performanceTotal": 0,    "performance": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "publishedOffers": 0,        "claims": 0,        "redeemed": 0      }    ]  },  "daily": [    {      "day": "2019-08-24",      "signups": 0,      "activeUsers": 0,      "newActiveUsers": 0,      "returningActiveUsers": 0,      "activityCoverage": "available",      "welcomeStarts": 0,      "rewardClaims": 0,      "merchantAdds": 0    }  ]}