Stats Live Activity for iOS Lock Screen Metrics

Live Activities now support a new activity type: stats.

Use stats to track several values at once. It fits up to 8 labeled values, such as revenue, number of users, conversion, uptime, or any metric set you want visible at a glance.

Each item has a label and value. Add an optional color when you want a small visual cue. Leave it out when you want plain text.

1
const status = await activitysmith.liveActivities.stream("sales-hourly", {
2
  content_state: {
3
    title: "Sales",
4
    subtitle: "last hour",
5
    type: "stats",
6
    metrics: [
7
      { label: "Revenue", value: "$2430", color: "blue" },
8
      { label: "Orders", value: "37", color: "green" },
9
      { label: "Conversion", value: "4.8%", color: "magenta" },
10
      { label: "Avg Order", value: "$65.68", color: "yellow" },
11
      { label: "Refunds", value: "$84", color: "red" },
12
      { label: "New Buyers", value: "18", color: "cyan" },
13
    ],
14
  },
15
});

View on GitHub

Node SDK

Call the same PUT /live-activity/stream/{stream_key} endpoint again whenever the values change. ActivitySmith keeps the Live Activity in sync on the device for you.

When the stats are no longer relevant, call DELETE /live-activity/stream/{stream_key} to end the Live Activity.

Add a dashboard button

Stats Live Activities can include the same optional action button as other Live Activity types. Use it to open the dashboard or report behind the numbers.

Set the action title to Dashboard, use open_url, and provide an HTTPS URL.

Stats Live Activity with a Dashboard action button

1
const status = await activitysmith.liveActivities.stream("sales-hourly", {
2
  content_state: {
3
    title: "Sales",
4
    subtitle: "last hour",
5
    type: "stats",
6
    metrics: [
7
      { label: "Revenue", value: "$2430", color: "blue" },
8
      { label: "Orders", value: "37", color: "green" },
9
      { label: "Conversion", value: "4.8%", color: "magenta" },
10
      { label: "Avg Order", value: "$65.68", color: "yellow" },
11
      { label: "Refunds", value: "$84", color: "red" },
12
      { label: "New Buyers", value: "18", color: "cyan" },
13
    ],
14
  },
15
  action: {
16
    title: "Dashboard",
17
    type: "open_url",
18
    url: "https://analytics.example.com/sales",
19
  },
20
});

View on GitHub

Node SDK

Availability

Available now across the API, SDKs, and CLI.

This feature is available in the ActivitySmith iOS app version 1.8.0 and newer.

Stats Live Activity for Lock Screen Metrics

Add a dashboard button

Availability