Developer Dashboard

Monitor API and AVL websocket usage, see your tier and quota, and review per-integrator consumption

Developer Dashboard

The Developer Dashboard surfaces your API and AVL websocket usage in one place. It's the home for billing-grade metering — current month's calls, your tier and quota, hourly trends, and per-integrator consumption — for tenants whose users are flagged as third-party integrators.

Access the Developer Dashboard from the sidebar under System → Developers → Overview.

Who This Is For

The Developer Dashboard is only meaningful for tenants that have at least one user marked as a third-party integrator (is_third_party_integrator = true). Those users' API calls and AVL websocket sessions are metered and counted against tier-based quotas.

If your tenant doesn't use the API directly — your team uses the dashboard only — this page won't show you anything interesting. That's expected.

Three Surfaces

The Developer Dashboard has three primary cards plus a usage table.

Summary Card

A snapshot of where you stand this month:

• API calls this month / quota — bar fills as you approach quota
• AVL connection hours this month / quota — same bar visualisation
• Tier — Free or Pro for each meter (API and AVL are billed separately)
• Days remaining in the current billing window

When you hit 80 % of either quota the bar turns amber; at 100 % it turns red and integrator requests start receiving HTTP 402 Payment Required responses (see Quota Gating below).

Usage Charts

Hourly trends across the billing window:

• API calls / hour — line chart of the rolling 24 h
• AVL connection minutes / hour — connection time aggregated hourly
• Calls by integrator — top integrators ranked by usage

Use these to spot a runaway script, an integration that suddenly went quiet, or a connection leak in your AVL client.

Integrators Table

Every integrator user in your tenant, ranked by usage this month:

Drill down into any integrator to see their hourly chart and recent request history.

Tiers and Quotas

API and AVL usage are metered and billed independently. Both have a Free and a Pro tier, configured at the tenant level under Settings → Plans.

Exact quota numbers are visible on the dashboard summary card. Upgrades are processed via Stripe or Revolut from the Plans screen.

Quota Gating

When integrator requests exceed the tier's monthly quota:

• API: subsequent integrator requests receive HTTP 402 Payment Required until the next billing cycle or a quota override is granted.
• AVL: new websocket connections from integrators are refused; existing connections drain naturally.

Non-integrator (dashboard) traffic is never quota-gated — your team keeps working normally.

Quota Overrides

For exceptional cases (a big customer integration spinning up, a one-time backfill run), Yipii staff can grant a Quota Override that lifts the cap for a specified period. Overrides are logged on the tenant's billing audit trail and visible to admins. Contact support to request one.

Webhook Usage Notifications

The Developer Dashboard fires automatic notifications when integrator usage crosses thresholds:

• 80 % of monthly quota — heads-up email + bell notification
• 100 % of monthly quota — quota-exceeded notice; integrator requests start failing with 402

Both notifications include a deep link straight to the dashboard so admins can review usage or upgrade their tier.

Refresh Cadence

• Realtime counters (current-month calls, AVL hours) update every few seconds via Redis-backed counters
• Hourly charts and per-integrator breakdowns roll up every 5 minutes from the metering pipeline
• Monthly quotas reset at 1st 00:01 UTC each month

Permissions

Best Practices

• Flag integrators correctly. Only users that actually call the API directly should be marked as integrators. Misclassifying internal staff inflates usage and burns quota.
• Watch the trend, not the snapshot. A flat hourly chart suggesting steady usage is healthy. A sudden vertical step usually means a script went haywire — investigate.
• Plan upgrades, don't hit walls. When usage crosses 80 % consistently for three days, upgrading saves the embarrassment of integrators getting 402s in production.
• Audit per-integrator monthly. A quick sweep of the integrators table catches stale users still authenticated months after they should have been disabled.
• Pair with the activity log. When an integrator suddenly spikes, the audit log shows which endpoints they're hammering.

FAQ

My tenant has no integrators — why does the page exist? The Developer Dashboard is part of the Settings menu but only renders meaningful data when at least one integrator is configured. For tenants that don't use the API directly, the page is mostly informational.

Are AVL connection minutes metered while idle? Yes — connection time, not call count, drives the AVL meter. An open websocket with no traffic still counts toward your hours allocation. Disconnect cleanly when your client doesn't need updates.

Why did my call get a 402? Integrator quota for the month has been hit. Either wait for the monthly reset, upgrade the tier, or ask Yipii for a temporary quota override.

Can I export the usage data? CSV export is on the roadmap — for now, the dashboard is read-only on screen.

What's the relationship to the Plans page? Plans is where you set tiers and process billing. The Developer Dashboard is the read-only consumption view. Upgrades happen on Plans; usage is monitored here.

Related Features

• Settings → Plans — tier selection and billing for API and AVL meters
• Automations — auto-trigger workflows when usage thresholds are crossed

Need Help?

Contact the Yipii support team for assistance with quota overrides, integrator flag changes, or upgrading your tier.