Tracking configuration

Turn on optional tracking features for a site, and read the public remote config the browser tracker itself fetches. A site is addressed by {siteKey} (UUID or domain) for the enable endpoints below. See Conventions for the base URL, headers, and error conventions shared by every authenticated endpoint.

Each enable endpoint flips one boolean flag on the Site model and invalidates the tracker's remote config cache, then returns the updated site through the same SiteResource used by Sites. All three are additive, idempotent toggles — calling one that is already on is a no-op that still returns 200 OK.

Session replay's enable endpoint is documented in full in Session replay — it shares this same pattern and response shape, so it isn't duplicated here.

Enable Web Vitals

POST /api/sites/{siteKey}/performance/enable

Route name: api.sites.performance.enable. Turns on track_web_vitals so the tracker starts sending Core Web Vitals measurements for the site.

Path parameters

Response — the updated site. Status: 200 OK.

curl -X POST "https://clickbase.so/api/sites/example.com/performance/enable" \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

await fetch('https://clickbase.so/api/sites/example.com/performance/enable', { method: 'POST', headers: { Authorization: `Bearer ${token}`, Accept: 'application/json' } })

requests.post('https://clickbase.so/api/sites/example.com/performance/enable', headers={'Authorization': f'Bearer {token}', 'Accept':'application/json'})

Enable error tracking

POST /api/sites/{siteKey}/error-tracking/enable

Route name: api.sites.error-tracking.enable. Turns on track_errors so the tracker starts reporting unhandled JS errors for the site.

Path parameters

Response — the updated site. Status: 200 OK.

curl -X POST "https://clickbase.so/api/sites/example.com/error-tracking/enable" \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

await fetch('https://clickbase.so/api/sites/example.com/error-tracking/enable', { method: 'POST', headers: { Authorization: `Bearer ${token}`, Accept: 'application/json' } })

requests.post('https://clickbase.so/api/sites/example.com/error-tracking/enable', headers={'Authorization': f'Bearer {token}', 'Accept':'application/json'})

Enable endpoint response fields

All three enable endpoints (performance/enable, error-tracking/enable, replays/enable) return the same SiteResource as the site-management endpoints — see the authoritative Response fields table in Sites for the full field set.

Public tracking config

GET /api/tracking-config/{trackingKey}

Route name: api.tracking-config.show. The public, unauthenticated remote config the browser tracker script fetches before its first pageview — this is where the toggles set by the enable endpoints above actually take effect client-side. {trackingKey} is the site's tracking key (the same value as data-site-id on the install snippet), not an OAuth-authenticated {siteKey}. Rate-limited on the shared tracking bucket (kept separate from /api/collect so config polls can't starve ingestion).

Path parameters

Response — a flat object:

Status: 200 OK. An unknown trackingKey returns 404 Not Found with { "message": "Not found." }.

curl "https://clickbase.so/api/tracking-config/{trackingKey}" \
  -H "Accept: application/json"

await fetch(`https://clickbase.so/api/tracking-config/${trackingKey}`, { headers: { Accept: 'application/json' } })

requests.get(f'https://clickbase.so/api/tracking-config/{tracking_key}', headers={'Accept': 'application/json'})