Talk to sales
VideoBI / Developers

Developers

Bring VideoBI dashboards into your own reporting site, BI tool or app: fetch any published dashboard as JSON, its layout and its data, and draw it your way.

What you can build

  • Your own reporting pages. Show the same numbers your team sees in VideoBI, inside your intranet or customer portal, in your design.
  • Data feeds. Pull a dashboard's figures on a schedule into a warehouse, a spreadsheet or another system.
  • AI agents and assistants. Give an agent a key and our rendering reference, and it can fetch and draw dashboards on its own.

The Dashboard API is part of the Professional and Enterprise plans. Embedding dashboards directly in other websites is coming next.

Quickstart

  1. Create an API key.In VideoBI, an owner or admin opens Settings → API keys and creates one. Copy it: it's shown only once. A key can be limited to some locations and given an expiry.
  2. List your dashboards.Every published dashboard the key can see, with its id.
  3. Fetch one, with its data.Pick a time range; the response holds each widget's layout, its metric and its data.
# 2. your published dashboards
curl -H "Authorization: Bearer $VIDEOBI_KEY" \
  https://app.videobi.ai/v1/api/dashboards

# 3. one dashboard with its data, for the last 7 days
curl -H "Authorization: Bearer $VIDEOBI_KEY" \
  "https://app.videobi.ai/v1/api/dashboards/DASHBOARD_ID?range=last_7_days"

Read the Dashboard API reference for every parameter, the response and errors, then render it with Apache ECharts.

For AI agents

Point your agent at the rendering reference, a single Markdown file written for language models: the API, the JSON, and how to turn each widget into an Apache ECharts option.

https://videobi.ai/developers/dashboard-rendering.md

It's also listed in /llms.txt, the common place agents look for documentation. Open the Markdown.

Good to know

  • Call it from a server. A key in a web page can be copied by anyone who opens it, so the API doesn't answer browser pages directly. Fetch on your server, then send your page the JSON.
  • Read-only. Keys read published dashboards; they can't change anything, see live video or use Ask.
  • 60 requests a minute per key. Dashboards update every 15 minutes, so caching a response for a few minutes costs you nothing.
  • Versioned. Every response carries api_version (now 1). We add fields without notice and announce anything that would break existing code.