Skip to main content
GET
Pipeline return over a window

Authorizations

Authorization
string
header
required

A workspace API key, created in workspace settings and sent as Authorization: Bearer op_live_…. Session cookies are not accepted. Scopes: signals:read, accounts:read, listeners:read, listeners:analyse, pipeline:read, pipeline:write, collections:write, export:read.

Query Parameters

days
integer
default:90

Window length in days. Bounds which deals closed inside it; openCount and weightedOpenMinor describe the board as it is now and ignore this.

Required range: x >= 1

Response

The window's return, in minor units of one currency.

What the pipeline sourced from Open Pulse signals is worth over a window.

Mixed currencies are not converted. There is no rate here and inventing one would produce a total that looks authoritative and is wrong, so the dominant currency is reported in currency and the figures are stated in it.

windowDays
integer
required

The window, in days. Closes are counted inside it; open deals are not.

wonCount
integer
required

Deals closed won in the window.

wonValueMinor
integer
required

Their total value, in minor units of currency.

lostCount
integer
required

Deals closed lost in the window.

openCount
integer
required

Deals currently in an open stage, regardless of the window.

weightedOpenMinor
integer
required

Open value × stage probability. A sales convention rather than a measurement, and labelled as one wherever it is shown.

currency
string
required

The currency most deals are actually in, not a default nobody set. GBP when no deal carries one.

Required string length: 3
winRate
number | null
required

Won ÷ (won + lost). null when nothing has closed, not 0 — a 0% win rate is a claim about performance that "nothing has closed yet" does not make.

Required range: 0 <= x <= 1
medianCycleDays
integer | null
required

Median days from created to closed. null when nothing has closed.