GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

listPipelineTransitions

Stage-to-stage deal movement.

POST/api/v1/callADMINreadrate-limitedruns as the key's owner
View as Markdown

Stage-to-stage deal movement (the funnel) for a reporting period (same period values as getPipelineAnalytics), optionally narrowed to one pipelineId: per transition: deal counts, exits from the source stage, and won/lost outcomes. Data is a nightly snapshot: see asOfDate. Requires the ADMIN scope (key owner must be a team admin).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listPipelineTransitions",
    "variables": {}
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.deals.listPipelineTransitions({})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'listPipelineTransitions',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

pipelineIdID
periodAgentAnalyticsPeriod

Default THIRTY_DAYS.

SEVEN_DAYSFOURTEEN_DAYSTHIRTY_DAYSSIXTY_DAYSTHIS_MONTHYEAR_TO_DATE

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "teamAnalyticsQuery": {
      "agentPipelineTransitions": [
        {
          "asOfDate": "…",
          "pipelineId": "<ID>",
          "pipelineName": "…",
          "fromStageId": "…",
          "fromStageName": "…",
          "toStageId": "…",
          "toStageName": "…",
          "transitionDealsCount": 0,
          "fromStageExitDealsCount": 0,
          "wonTransitionDealsCount": 0,
          "lostTransitionDealsCount": 0,
          "transitionsToWonStage": true,
          "transitionsToLostStage": true
        }
      ]
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

429rate_limited

The per-key limit for a rate-limited operation, or the per-IP throttle before auth.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request. Rate-limited per key: over the budget returns 429 rate_limited with Retry-After.

READgetDealREADfindDealsREADsurveyDealsREADlistStalledDealsREADlistPipelinesREADlistDealFilters