getFormAnalytics

Conversion funnel for one form over a date range - views, starts, submits, the start/submit/submit-of-started rates (0-1 fractions), median seconds-to-submit, plus a per-day time series. startDate and endDate are ISO YYYY-MM-DD; ranges longer than 90 days are rejected.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getFormAnalytics",
    "variables": {
      "formId": "<formId>",
      "startDate": "<String>",
      "endDate": "<String>"
    }
  }'

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.forms.getFormAnalytics({
  formId: '<formId>',
  startDate: '<String>',
  endDate: '<String>'
})

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: 'getFormAnalytics',
    variables: {
      formId: '<formId>',
      startDate: '<String>',
      endDate: '<String>'
    }
  }),
})
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.

formIdID!required

startDateString!required

endDateString!required

Response

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

response shape

{
  "data": {
    "embedFormQuery": {
      "analyticsFunnel": {
        "funnel": {
          "views": 0,
          "starts": 0,
          "submits": 0,
          "startRate": 0,
          "submitRate": 0,
          "submitRateOfStarted": 0,
          "p50SecondsToSubmit": 0
        },
        "funnelDaily": [
          {
            "viewDate": "…",
            "views": 0,
            "starts": 0,
            "submits": 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.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "getFormAnalytics", "variables": { "formId": "<formId>", "startDate": "<String>", "endDate": "<String>" } }'

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.forms.getFormAnalytics({ formId: '<formId>', startDate: '<String>', endDate: '<String>' })

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: 'getFormAnalytics', variables: { formId: '<formId>', startDate: '<String>', endDate: '<String>' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related