Developers
V1PlatformWorkspacesTenantidAnalytics

Workspace operational analytics with a fresh password session and live platform admin role

Malaysia calendar dates, at most 366 days; the window preserves selected dates and daily rows omit future dates. Current membership, invitation and stock counts use report time, independent of the selected period. Period counts use membership join/end timestamps, invitation creation/acceptance timestamps, and claims reserved in the period. Invitation and claim cohort outcomes are mutually exclusive as of report time, not period end. Daily claim outcomes are grouped by claim reservation date. Membership history is the latest stored membership edge, not a complete rejoin ledger; deleted and pending-deletion accounts are excluded. No employee identities, health values, health participation, app activity, or individual sharing status are returned. MC operational totals are available only to the current corporate workspace owner or HR admin through the partner endpoint. They include requests explicitly submitted with valid sharing consent, exclude drafts and departed/deleted employees, and count submitted, approved, rejected and withdrawn requests. Calendar-day totals count inclusive overlap with the full selected dates, including future dates; they do not establish entitlement or predict absence. Platform endpoints never include MC totals.

GET
/v1/platform/workspaces/{tenantId}/analytics

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

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

application/json

curl -X GET "https://example.com/v1/platform/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/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"  },  "tenant": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "status": "pending"  },  "workplace": {    "current": {      "members": {        "total": 0,        "owners": 0,        "hrAdmins": 0,        "staff": 0,        "employees": 0      },      "pendingInvitations": 0    },    "period": {      "membersJoined": 0,      "membersEnded": 0,      "invitationsCreated": 0,      "invitationsAccepted": 0,      "invitationCohort": {        "total": 0,        "accepted": 0,        "pending": 0,        "revoked": 0,        "expired": 0      }    }  },  "kind": "merchant",  "merchant": {    "current": {      "offers": {        "total": 0,        "draft": 0,        "published": 0,        "archived": 0      },      "submissions": {        "total": 0,        "draft": 0,        "submitted": 0,        "changesRequested": 0,        "published": 0      },      "stock": {        "claimableOffers": 0,        "total": 0,        "redeemed": 0,        "reserved": 0,        "available": 0      }    },    "period": {      "claims": 0,      "redeemed": 0,      "reserved": 0,      "expired": 0,      "cancelled": 0    }  },  "daily": [    {      "day": "2019-08-24",      "membersJoined": 0,      "membersEnded": 0,      "invitationsCreated": 0,      "invitationsAccepted": 0,      "claims": 0,      "redeemed": 0,      "reserved": 0,      "expired": 0,      "cancelled": 0    }  ]}

Admin approves and publishes a submitted offer or requests changes POST

One published pilot offer per merchant. An admin must select the pilot claim policy first. Publication is immutable and immediately visible in the app; requesting changes requires a note.

Published welcome campaigns with your own claim status when signed in GET

One claim per account and campaign, not one per person. No health, step or IC data is required. Nothing is published by default.