SDK reference
Core concepts

Reading the dashboard

Move from workflow outcomes to the evidence behind a specific execution.

Start with the workflow overview

The overview shows volume, success rate, median and p95 duration, failed-run count, week-over-week change, 30-day volume and duration charts, slowest operations, failure codes, five workflows ordered by success rate, and five recent runs. Use it to find a process that needs investigation.

Browse workflows and runs

Open Workflows for a table grouped by name prefix. Search, filter by naming namespace, or sort by name group or run count. Each page contains at most 12 workflows; selecting one opens its summary and recent executions.

Open Runs to search SDK run IDs, workflow names, last checkpoints, correlation IDs or parent IDs. Combine workflow, status and naming-namespace filters; sort by start time or duration; optionally group rows by workflow. Each page contains at most 15 runs.

Run browsing filters and paginates the project's latest 100 runs. Metrics cover recorded runs and daily volume covers 30 days. Naming namespace is inferred from workflow name prefixes.

Open an execution

Run details open on Outcome. Separate tabs keep investigation focused:

  • Outcome: reported result, failure, last-reported progress, and evidence counts. Expand raw result data when needed.
  • Timeline: filter event types and expand rows for occurrence/receipt times, operation timing, properties, progress and safe error details. Each page contains at most 15 events.
  • Context: properties, environment, release and the external SDK run ID.
  • Compare: this run versus the last 20 of the same workflow — duration against the peer median and p95, plus each peer's outcome.
  • Related runs: explicitly declared parent matches and correlated runs, paginated independently at 10 rows per table.

For an import, check the imported/skipped result first. For an interrupted sync, inspect the last-reported progress and the failure. For an order failure, inspect checkpoints before retrying work that may already have side effects.

Settings and projects

Settings is where you rename or create a project, create or rotate ingestion keys, and update the signed-in name or password. A write key is shown once. The sidebar switches between projects you own. Dashboard sign-in does not replace the SDK key.

How to read a run

Completed means the application called done(). Failed means it called fail(). A handled error can sit next to a completed run. Last-reported progress is the latest snapshot your code sent.

Connect to deeper investigation

Use stable, non-sensitive business identifiers in properties when you want to look up the same work in your logs. Related runs use the IDs you pass. The API guide explains internal IDs and project-scoped queries.

On this page