GoliathDevelopersGet an API key
Reference/Formsgenerated from the gateway manifest

getFormTrafficSources

Where a form's traffic and submissions come from - breakdowns by traffic source, device class, and location, each with views, submits, and the submit rate.

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

Where a form's traffic and submissions come from - breakdowns by traffic source, device class, and location, each with views, submits, and the submit rate.

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

Response

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

response shape
{
  "data": {
    "embedFormQuery": {
      "analyticsSourcesDevices": {
        "trafficSources": [
          {
            "trafficSource": "…",
            "views": 0,
            "submits": 0,
            "rate": 0
          }
        ],
        "deviceMix": [
          {
            "deviceClass": "…",
            "views": 0,
            "submits": 0,
            "rate": 0
          }
        ],
        "locationMix": [
          {
            "city": "…",
            "region": "…",
            "country": "…",
            "views": 0,
            "submits": 0,
            "rate": 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.

READlistFormsREADgetFormREADlistFormSubmissionsREADgetFormSubmissionREADgetFormAnalyticsREADlistFormActivity