Skip to Content
splashify CLIDashboard

Dashboard

The dashboard command mirrors the app’s home /dashboard page — the signals it surfaces at-a-glance: WABA + phone status, setup checklist, current plan, wallet balance, AI-credit balance, and KYC state.

All endpoints are read-only. Writes (sync-meta, register-phone, OBA apply, etc.) live under splashify waba to keep this surface focused on observation.

Quick start

splashify dashboard                  # consolidated snapshot (default)
splashify dashboard setup-status     # just the setup checklist
splashify dashboard whatsapp-status  # just the WhatsApp / Meta status
splashify dashboard kyc              # KYC verification status

Command reference

SubcommandBacked by
(none — default) / overviewMerges all six reads below into one JSON object
setup-status / setupGET /api/v1/app/dashboard/setup-status
whatsapp-status / whatsapp / waGET /api/v1/app/dashboard/whatsapp-status
kyc / kyc-statusGET /api/v1/app/kyc/status
embedded-signup-config / es-configGET /api/v1/app/dashboard/embedded-signup/config

Consolidated view

splashify dashboard

Returns:

{
  "setup_status":    { "...": "WABA setup checklist" },
  "whatsapp_status": { "phone_number": "+91...", "waba_id": "..." },
  "plan":            { "user": { "plan_name": "...", "plan_status": "..." } },
  "wallet":          { "wallet_amount": 1234.56 },
  "ai_credits":      { "balance": 100 },
  "kyc":             { "status": "verified" }
}

A section that fails for any reason is reported as {"error": "..."} for that key — the rest of the view still renders. Same pattern as splashify account and splashify billing.

Common patterns

# At-a-glance status pill
splashify dashboard | jq '{
  plan:      .plan.user.plan_name,
  status:    .plan.user.plan_status,
  wallet:    .wallet.wallet_amount,
  credits:   .ai_credits.balance,
  waba:      .whatsapp_status.waba_status,
  kyc:       .kyc.status
}'
 
# Just the next setup step
splashify dashboard setup-status | \
  jq '.steps[] | select(.status != "completed") | {id, title, status}' | head
 
# Cron-friendly health check: exit non-zero if KYC is not verified
splashify dashboard kyc | jq -e '.status == "verified"'
CommandsMessages (inbox)