Skip to main content

Documentation Index

Fetch the complete documentation index at: https://activitysmith.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

ActivitySmith Lock Screen widgets

​
How It Works

  1. Create a metric in the web app.
  2. Update the value using API anytime it changes.
  3. Add the widget to your iPhone Lock Screen.
  4. The widget fetches the latest value about every 15 minutes. iOS manages the refresh schedule.
When creating a metric, you can choose the format: number, currency, percent, unit, or string. Create a widget metric in ActivitySmith

​
Updating Metric Value

Use the metric key when sending updates. Values can be numbers or strings. 
import ActivitySmith from "activitysmith";

const activitysmith = new ActivitySmith({
  apiKey: process.env.ACTIVITYSMITH_API_KEY,
});

await activitysmith.metrics.update("deploy.success_rate", 99.9);
For the full API reference, see Update Metric Value.