​

Playbook API

The Playbook API manages play effectiveness computation and retrieval. GET queries effectiveness data with optional filters; POST recomputes effectiveness metrics from play outcome data.

​

GET /api/plays/effectiveness

Returns play effectiveness metrics with optional segment, tier, and territory filters. Auth: Requires authenticated session. Scoped to organization.

​

Query Parameters

​

Response

​

Response Fields: kpi

​

Response Fields: effectiveness[]

---

​

POST /api/plays/effectiveness

Recomputes effectiveness metrics from play outcome data and persists results. Auth: Requires authenticated session. Scoped to organization.

​

Request Body

No body required.

​

Response

​

Computation Flow

1. Load all plays with outcomes
2. Load outcome feedback data
3. Load account context (segment, tier, territory, ARR, health score) for play accounts
4. Group plays by template x segment x tier
5. Compute win rate, avg time to complete, ARR impact, health delta per group
6. Persist results (keyed on organization + play template + segment + tier)

​

Positive Outcomes

The following outcomes are classified as successful: RENEWED, WON, EXPANDED, SAVED, UPSOLD.

See the Playbook Evolution data model page for full details on the effectiveness computation, segment affinity analysis, and recommendation generation.