GoliathDevelopersGet an API key
Reference/Dealsgenerated from the gateway manifest

getPipelineAnalytics

Per-pipeline TRENDS for a rolling period.

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

Per-pipeline TRENDS for a rolling period (SEVEN_DAYS | FOURTEEN_DAYS | THIRTY_DAYS | YEAR_TO_DATE; THIRTY_DAYS is the last 30 days, not this month) from a NIGHTLY snapshot (asOfDate): stage duration, stage mix, won/lost/active. wonDeals / lostDeals count EVENTS (moves into a won or lost stage in the window, archived deals included) and miss moves since the snapshot, so they can disagree with the deals as they stand: for "how many won", a win rate or money use findDeals totals (outcome WON / LOST, a stageChanged window). Requires the ADMIN scope.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getPipelineAnalytics",
    "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.getPipelineAnalytics({})
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: 'getPipelineAnalytics',
    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.

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": {
      "agentPipelineInventory": {
        "asOfDate": "…",
        "period": "SEVEN_DAYS",
        "reportingPeriod": "…",
        "startDate": "…",
        "endDate": "…",
        "pipelines": [
          {
            "pipelineId": "<ID>",
            "pipelineName": "…",
            "wonDeals": 0,
            "lostDeals": 0,
            "activeDealsCount": 0,
            "avgStageDurationDays": 0,
            "currentStageMix": [
              {
                "stageName": "…",
                "dealCount": 0
              }
            ]
          }
        ]
      }
    }
  }
}

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