Published
Proof Points
Short answer
get_proof_points returns a small JSON snapshot of project QA posture: non-archived releases in the last 30 days, scenario coverage percent, and test scenario count. Create a restricted API key with the Proof points template so the key can call only this endpoint.
Create a restricted key
- Open Project Settings → General (Key management).
- Click Create Restricted Key.
- Choose the Proof points template (or select
get_proof_pointsonly). - Optionally set a label (for example
Dealpuffin). - Copy the key when shown — treat it like any secret.
Restricted keys return 403 on any other /api/mcp/** tool and on non-MCP API-key routes. Full-access keys from Add key are unchanged.
Call the API
curl -sS -X POST "https://featureservice.testchimp.io/api/mcp/get_proof_points" \
-H "Content-Type: application/json" \
-H "TestChimp-Api-Key: $TESTCHIMP_API_KEY" \
-d '{}'
Example response:
{
"releasesLast30Days": 12,
"scenarioCoveragePercent": 78.5,
"testScenarioCount": 140,
"windowDays": 30,
"asOfMillis": "1730000000000"
}
| Field | Meaning |
|---|---|
releasesLast30Days | Non-archived catalog releases first-seen or created in the window |
scenarioCoveragePercent | Share of automation-candidate scenarios with at least one linked SmartTest |
testScenarioCount | Non-archived test scenarios in the project planning scope |
windowDays | Window length (currently always 30) |
asOfMillis | Server clock when the response was produced |
MCP / CLI
Tool name: get-proof-points. Same auth header via TESTCHIMP_API_KEY.
Related
- API Basics — unrestricted vs restricted keys
- Interactive API Reference
Frequently asked questions
What does get_proof_points return?
releasesLast30Days, scenarioCoveragePercent, testScenarioCount, windowDays, and asOfMillis for the project resolved from the API key.
How do I limit a key to proof points only?
In Project Settings create a Restricted Key with the Proof points template so only get_proof_points is allowlisted.
What is scenario coverage percent?
The percentage of automation-candidate scenarios that have at least one linked SmartTest (same definition as the planning dashboard).
FAQ
What does get_proof_points return?
releasesLast30Days, scenarioCoveragePercent, testScenarioCount, windowDays, and asOfMillis for the project resolved from the API key.
How do I limit a key to proof points only?
In Project Settings create a Restricted Key with the Proof points template so only get_proof_points is allowlisted.
What is scenario coverage percent?
The percentage of automation-candidate scenarios that have at least one linked SmartTest (same definition as the planning dashboard).