Skip to main content
Documentation

Reports

reports.recovered_revenue

Read the report on money the AI front desk won back
Read-onlyRead budget

REST

Shipping
POST /api/v1/reports/recovered_revenue

MCP tool

Live
reports.recovered_revenue

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Reports domain.

Operating contract

WHAT THE MISSED CALLS WERE WORTH. When a call goes unanswered and the AI texts back, this traces that thread all the way to a paid invoice and totals what it brought in.

recovered_cents IS THE ONLY MONEY FIGURE HERE and it is in CENTS. It counts paid invoices whose chain traces back to an AI-answered missed call — not quoted, not booked, PAID.

THE FUNNEL NARROWS HONESTLY: answered is missed calls the AI texted back and is the denominator; then replied, quoted, booked, paid. A quote the AI drafted on a thread that did not start with a missed call is a real quote and is deliberately not counted here — this measures one specific rescue, not the AI's whole contribution.

saved_calls IS THE SENTENCE A SHOP OWNER REMEMBERS. 'Nine calls you would have missed turned into $14,000' lands where a percentage does not.

available: false means migration 0164 is not applied to this shop's database. Every figure is then zero because there is nothing to read, NOT because nothing was recovered — say which.

truncated: true means the row cap was hit and every figure UNDER-counts. Say 'at least'.

The window's figures are entirely returned, so nothing is truncated beyond that row cap.

Who may call it

Permission
reports.accessThe caller must hold Reports & insights at the ACT level. A read-only dashboard grant on the same section is refused.
Plan
Every planNo plan gate. Available on every Service VIN plan.
Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class
readCounted against the read budget — the widest of the four.

Input

FieldTypeDescription
rangestring

The window: 7d, 30d, 90d, 12mo, ytd or all. Defaults to 30d.

Default: "30d"One of: 7d, 30d, 90d, 12mo, ytd, all

Output

FieldTypeDescription
availableboolean

sincestring

recovered_centsnumber

saved_callsnumber

truncatedboolean

funnelobject

funnel.answerednumber

funnel.repliednumber

funnel.quotednumber

funnel.bookednumber

funnel.paidnumber

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/reports/recovered_revenue \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"range":"30d"}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/reports/recovered_revenue", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "range": "30d"
  }),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/reports/recovered_revenue",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "range": "30d"
},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reports.recovered_revenue",
    "arguments": {
      "range": "30d"
    }
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold reports.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.