📊 API Console

What is the API Console?

The Dockflow API Console gives service‑providers a live view on how integrations are behaving:

Log in with the same Dockflow account that generated the API token.
Choose environment at the top‑right corner:
- Production – api.dockflow.com tokens (prod_…)
- UAT sandbox – uat.dockflow.com tokens (uat_…)

Only the endpoints covered by your token’s scope (downstream, upstream, widget) appear in the dashboards.

Tab	What you’ll see
Overview	Total requests, success rate, average latency.
Downstream	Tradeflow & document posts, validation errors, typical payload size.
Upstream	Webhook deliveries, retry count, polling frequency.
Widgets	Search traffic, longest response times, 4xx vs 5xx split.
Error Explorer	Drill down into individual 4xx/5xx responses with full payload sample (PII redacted).
Exports	Download daily CSV or JSON lines of webhook results and error logs.

Metric	Definition
Requests	Count of HTTP calls that reached Dockflow (excludes blocked CORS/SSL).
Success rate	`(2xx + 3xx) ÷ total` in the selected period.
Median / p95 latency	Time from first byte received to first byte sent.
Validation failure	`400 Bad Request` responses caused by schema or business‑rule errors.
Webhook retries	Automatic redelivery attempts after a non‑2xx response from your endpoint.

Email alerts can be set for:
- error‑rate spike
- sustained latency above a threshold
- webhook queue back‑pressure
Slack integration – send the same alerts to a channel.
All alerts support separate thresholds for Production and UAT.

Configure alerts in Console › Settings › Notifications.

Contact Dockflow support if longer retention is required.

Check the Help menu inside the console or email [email protected].
Engineers typically respond within one business day.