Monitoring and usage

Two read-only aggregate endpoints back the operational screens of an app: GET /flows/dashboard/summary is a one-call “what’s happening right now” pulse, and GET /flows/usage is a time-bucketed analytics series with a per-definition breakdown. Both compute live from your account’s batches and schedules and return a single object — no pagination.

Dashboard summary: `GET /flows/dashboard/summary`

One call paints the home screen. The response composes four sections so the client makes no follow-up round trips.

curl "$BASE_URL/flows/dashboard/summary" \
  -H "X-API-Key: $GETDIALED_API_KEY"

{
  "batches_by_status": {"completed": 128, "failed": 4, "running": 2},
  "recent_failures": [
    {
      "id": "batch_55667788",
      "definition_id": "def_a1b2c3d4",
      "source": "schedule",
      "failed_at": "2026-07-09T18:00:05Z"
    }
  ],
  "active_schedule_count": 6,
  "upcoming_fires": [
    {
      "schedule_id": "sched_1a2b",
      "definition_id": "def_a1b2c3d4",
      "next_fire_at": "2026-07-10T09:00:00Z"
    }
  ]
}

Field	Type	Description
`batches_by_status`	object	Batch counts keyed by status over the last 24 hours.
`recent_failures`	array	The most recent failed batches, newest first — each row carries `id`, `definition_id`, `source`, and `failed_at`, denormalized so the failure feed renders without extra lookups.
`active_schedule_count`	integer	Number of currently-enabled schedules.
`upcoming_fires`	array	The next few schedule fires, soonest first — `schedule_id`, `definition_id`, and the computed `next_fire_at` (UTC).

Usage analytics: `GET /flows/usage`

GET /flows/usage returns a time series of run activity plus a per-definition top-N volume table for the analytics screen.

Query parameters

Parameter	Type	Description
`from`	datetime	Start of the range (inclusive).
`to`	datetime	End of the range (inclusive).
`granularity`	enum	Time-bucket size: `hour`, `day`, or `week`.

The range is validated against the granularity so a single request can’t ask for an unbounded number of buckets — for example, hour buckets are capped to a short span while week buckets allow a much longer one. A range that would produce too many buckets returns 422. Bucket timestamps are UTC.

curl "$BASE_URL/flows/usage?from=2026-07-01T00:00:00Z&to=2026-07-09T00:00:00Z&granularity=day" \
  -H "X-API-Key: $GETDIALED_API_KEY"

{
  "series": [
    {"bucket": "2026-07-09T00:00:00Z", "total": 42, "succeeded": 40, "failed": 2}
  ],
  "top_definitions": [
    {"definition_id": "def_a1b2c3d4", "total": 128, "succeeded": 124}
  ]
}

Field	Type	Description
`series`	array	Per-bucket run counts over the range, oldest first. Each bucket carries `bucket` (start time, UTC), `total`, `succeeded`, and `failed`.
`top_definitions`	array	The busiest definitions in the range (~top 20 by run count), each with `definition_id`, `total`, and `succeeded`. Success rates are derivable client-side.

The usage payload has no quota or plan block — it reports what ran, not entitlement limits. Compute success rate as succeeded / total per bucket or per definition on the client.

Finding a run by business key

The dashboard and usage feeds answer “how is everything doing”. Support questions arrive the other way round: someone has a lead id or a phone number and needs the one run that touched it. They do not have an execution id, and scanning batches for it does not scale. Two steps make that a single query:

Declare the key searchable on the definition. Add the input to searchable_inputs — up to five per flow. Every run started after that records the resolved value.
Filter the executions feed on it.

GET /flows/executions?definition_id=def_a1b2c3d4&attr.lead_id=48213

That returns the matching runs in the standard Page envelope, each echoing its search_attrs so you can confirm you have the right one. Take the id from the row and GET /flows/executions/{id} for the per-step detail — which step ran, which failed, and why. Phone numbers are stored in international format, so (707) 634-2533 and +1 707 634 2533 find the same run when queried as attr.phone=%2B17076342533. Several attr. filters combine with AND. The full parameter list is on the account-wide executions feed.

A run only carries the keys its definition declared before that run started. If a search returns nothing, check whether searchable_inputs was in place at the time — declaring it now does not backfill past runs.

Next steps

Batches, jobs, and executions

Drill from a dashboard row into the account-wide runs feed, or find one run by its business key.

Schedules

Manage the schedules behind the upcoming-fires list.

Flow definitions

Declare which of a flow’s inputs its runs can be looked up by.

Getting Started

Core Concepts

Building Flows

Triggers & Streaming

Dashboard summary: `GET /flows/dashboard/summary`

Usage analytics: `GET /flows/usage`

Query parameters

Finding a run by business key

Next steps

Batches, jobs, and executions

Schedules

Flow definitions

​Dashboard summary: GET /flows/dashboard/summary

​Usage analytics: GET /flows/usage

​Query parameters

​Finding a run by business key

​Next steps

Batches, jobs, and executions

Schedules

Flow definitions

Dashboard summary: `GET /flows/dashboard/summary`

Usage analytics: `GET /flows/usage`

Query parameters

Finding a run by business key

Next steps