Documentation
Reports
reports.sla
REST
ShippingPOST /api/v1/reports/slaMCP tool
Livereports.slaExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Reports domain.
Operating contract
How fast this shop answers a new enquiry, measured against the target it set: the median, the 90th percentile, and the share answered inside the target.
THE 90TH PERCENTILE IS THE HONEST ONE. A median of six minutes with a p90 of nine hours means most enquiries are answered fast and one in ten waits most of a day — and it is the one in ten that leaves a review about never hearing back. Report both or report the p90.
missed is enquiries with NO response yet that are ALREADY past the target. That is the live list, and it is different from pending, which is unanswered but still inside the window and needs nobody to panic.
ai_answered counts responses an AI agent made rather than a person. A shop whose speed is excellent and entirely AI-answered is a shop whose speed is a property of its automations, and that is worth saying rather than congratulating anybody.
enabled: false means the shop has the first-response clock switched off, and every figure here is then measured against a default nobody chose. Say so.
Percentiles are NEAREST-RANK — the value at an actual observation — so 'our p90 is 41 minutes' points at a real lead somebody can open.
truncated is a flag rather than a count: when it is true a row cap bit and every figure on this response UNDERCOUNTS. Narrow the range and ask again, and say the period could not be read in full rather than quoting the totals.
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
expensiveCounted against the expensive budget — a model call, a document render or a fan-out scan.
Partial answers
truncated is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.
Do not summarise from a truncated response
Input
| Field | Type | Description |
|---|---|---|
| range | string | The window: 7d, 30d, 90d, 12mo, ytd or all. Defaults to 30d. Default:"30d"One of: 7d, 30d, 90d, 12mo, ytd, all |
Output
| Field | Type | Description |
|---|---|---|
| range | string | — |
| enabled | boolean | — |
| target_minutes | number | — |
| business_hours_only | boolean | — |
| truncated | boolean | — |
| has_data | boolean | — |
| overall | object | — |
| overall.leads | number | — |
| overall.answered | number | — |
| overall.ai_answered | number | — |
| overall.missed | number | — |
| overall.pending | number | — |
| overall.within_target | number | — |
| overall.median_minutes | number | null | — |
| overall.p90_minutes | number | null | — |
| overall.within_pct | number | null | — |
| by_source | object[] | — |
| by_source[].key | string | — |
| by_source[].label | string | — |
| by_source[].leads | number | — |
| by_source[].answered | number | — |
| by_source[].median_minutes | number | null | — |
| by_source[].within_pct | number | null | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/reports/sla \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"range":"30d"}'const res = await fetch("https://www.servicevin.com/api/v1/reports/sla", {
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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/reports/sla",
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"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "reports.sla",
"arguments": {
"range": "30d"
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold reports.access. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many expensive calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |