Skip to main content

Export Report JSON for BI Tools

Feed your own BI and analytics tools with machine-readable drift data. Learn how to export JSON from vg report and where to write it with --out.

Vibgrate Docs

Vibgrate Help

If your organization standardizes reporting in a BI tool, you will want drift data in a machine-readable form you can ingest. This guide shows how to export JSON from a Vibgrate CLI scan for downstream analytics.

Overview

vg report can render scan artifacts as JSON instead of Markdown or text. JSON is structured for tooling: you can load it into a data pipeline, a warehouse, or a BI dashboard and chart DriftScore alongside your other engineering metrics.

Prerequisites

  • A completed scan in the project (run vg first).
  • A destination that can ingest JSON files.

Step-by-step

Generate a JSON report and write it to a file:

vg report --format json --out drift.json

Pick up drift.json from your pipeline and load it into your warehouse or BI tool. Because the format is stable JSON, you can extract the DriftScore and finding detail programmatically.

Examples

Emit JSON to stdout to pipe into another tool:

vg report --format json

In a scheduled job, write a timestamped artifact your pipeline collects:

vg report --format json --out drift.json

When to use the dashboard instead

If you do not need the data inside your BI stack, Vibgrate Cloud already charts DriftScore and trends for you — see View Drift Trends on the Dashboard. Export JSON when you specifically need the numbers in your own tooling.

Related

Generate a Drift Report from Scan Artifacts, the Output Formats guide, and Push Scan Results to Vibgrate Cloud.

Related Commands