GoliathDevelopersGet an API key
Reference/Teamgenerated from the gateway manifest

getTeamAnalyticsOverview

Team performance.

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

Team performance (SEVEN_DAYS | FOURTEEN_DAYS | THIRTY_DAYS | YEAR_TO_DATE; default THIRTY_DAYS): totals, deltas, per-agent rows. NIGHTLY as of asOfDate, never today; say which numbers are nightly and which live (getTeamCallStats, countOutboundTexts). filterContacts awaitingReply: unanswered texts/emails. avgSpeedToFirst{Call,Message}Minutes: minutes from a lead being ASSIGNED to the member to their first call / text or email.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getTeamAnalyticsOverview",
    "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.team.getTeamAnalyticsOverview({})
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: 'getTeamAnalyticsOverview',
    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": {
      "agentTeamOverview": {
        "asOfDate": "…",
        "period": "SEVEN_DAYS",
        "reportingPeriod": "…",
        "startDate": "…",
        "endDate": "…",
        "summary": {
          "agentCount": 0,
          "calls": 0,
          "completedCalls": 0,
          "conversationCalls": 0,
          "callsDeltaPct": 0,
          "texts": 0,
          "textsDeltaPct": 0,
          "emails": 0,
          "emailsDeltaPct": 0,
          "tasks": 0,
          "tasksDeltaPct": 0,
          "appointments": 0,
          "appointmentsDeltaPct": 0,
          "newLeads": 0,
          "newLeadsDeltaPct": 0,
          "notActedOnCount": 0,
          "activeLeadsCount": 0,
          "warmLeadsCount": 0,
          "coolingLeadsCount": 0,
          "coldLeadsCount": 0,
          "deadLeadsCount": 0
        },
        "agents": [
          {
            "userId": "<ID>",
            "userName": "…",
            "userEmail": "…",
            "calls": 0,
            "texts": 0,
            "emails": 0,
            "tasks": 0,
            "appointments": 0,
            "newLeads": 0,
            "notActedOnCount": 0,
            "avgSpeedToFirstCallMinutes": 0,
            "avgSpeedToFirstMessageMinutes": 0,
            "activeLeadsCount": 0,
            "warmLeadsCount": 0,
            "coolingLeadsCount": 0,
            "coldLeadsCount": 0,
            "deadLeadsCount": 0,
            "score": 0,
            "conversationRate": 0
          }
        ],
        "pipelineExposure": [
          {
            "pipelineId": "<ID>",
            "pipelineName": "…",
            "userId": "<ID>",
            "userName": "…",
            "wonDealsCount": 0,
            "lostDealsCount": 0,
            "commissionEarnedCents": 0
          }
        ]
      }
    }
  }
}

Errors

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.