{"version":"1.3.0","lastUpdated":"2026-04-11T12:08:32.048Z","project":"docs","pages":[{"path":"/forward","name":"Forward Docs Home","sections":["header","hero","getting-started","sidebar"]},{"path":"/forward/[...slug]","name":"Forward Docs Page","sections":["header","sidebar","breadcrumbs","content","toc","pagination","feedback"]},{"path":"/classic","name":"Classic Docs Home","sections":["header","hero","getting-started","sidebar"]},{"path":"/classic/[...slug]","name":"Classic Docs Page","sections":["header","sidebar","breadcrumbs","content","toc","pagination","feedback"]},{"path":"/api-reference","name":"API Reference Index","sections":["header","sidebar","content"]},{"path":"/api-reference/[...slug]","name":"API Reference Page","sections":["header","sidebar","content","parameters","responses","examples"]},{"path":"/sql-reference","name":"SQL Reference Index","sections":["header","sidebar","content"]},{"path":"/sql-reference/[...slug]","name":"SQL Reference Page","sections":["header","sidebar","content","toc"]},{"path":"/changelog","name":"Changelog Index","sections":["header","content","changelog-list"]},{"path":"/changelog/[slug]","name":"Changelog Entry","sections":["header","content"]},{"path":"/community","name":"Community Page","sections":["header","content","slack-form"]},{"path":"/live","name":"Live Stream Page","sections":["header","content","video-player"]}],"events":[{"name":"docs_search","enumKey":"SEARCH","category":"search","categoryName":"Search Events","description":"Tracks when a user performs a search in the documentation search modal.","trigger":"Fires after debounced search input when Pagefind returns results.","pages":["all"],"sections":["header"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"search_term","type":"string","description":"The search query entered by the user","required":true,"exampleValues":["kafka connector","ingest data","API token"]}]},{"name":"feedback_submitted","enumKey":"FEEDBACK_SUBMITTED","category":"feedback","categoryName":"Feedback Events","description":"Tracks when a user submits feedback via the 'Was this page helpful?' form.","trigger":"Fires when user clicks Submit after selecting a feedback option.","pages":["forward/*","classic/*"],"sections":["feedback"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"path","type":"string","description":"Whether the user clicked 'yes' or 'no'","required":true,"exampleValues":["yes","no"]},{"name":"checkboxValue","type":"string","description":"The feedback category selected by the user","required":true,"exampleValues":["easy_to_understand","solved_my_problem","hard_to_understand","couldnt_find_information"]},{"name":"moreFeedback","type":"string","description":"Optional additional feedback text provided by the user","required":false,"exampleValues":["Great explanation!","Missing code examples"]}]},{"name":"form_submitted","enumKey":"FORM_SUBMITTED","category":"feedback","categoryName":"Feedback Events","description":"Tracks when a user submits the Slack community invitation form.","trigger":"Fires when HubSpot form is submitted on the community page.","pages":["/community"],"sections":["content"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"user-agent","type":"string","description":"Browser user agent string","required":true,"exampleValues":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"]},{"name":"locale","type":"string","description":"User's browser locale","required":true,"exampleValues":["en-US","es-ES","fr-FR"]},{"name":"location","type":"string","description":"User's country based on timezone","required":true,"exampleValues":["US","ES","GB"]},{"name":"referrer","type":"string","description":"The referring URL","required":true,"exampleValues":["https://google.com","https://tinybird.co"]},{"name":"pathname","type":"string","description":"The current page pathname","required":true,"exampleValues":["/community"]},{"name":"href","type":"string","description":"The full URL of the page","required":true,"exampleValues":["https://www.tinybird.co/docs/community"]}]},{"name":"page_hit","enumKey":"PAGE_HIT","category":"core","categoryName":"Core Events","description":"Tracks every page view for Tinybird analytics with detailed metadata and UTM attribution (session + first-touch).","trigger":"Fires on every page navigation via Next.js router.","pages":["all"],"sections":[],"properties":[{"name":"user-agent","type":"string","description":"Browser user agent string","required":true,"exampleValues":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"]},{"name":"locale","type":"string","description":"User's browser locale","required":true,"exampleValues":["en-US","es-ES"]},{"name":"location","type":"string","description":"User's country based on timezone","required":true,"exampleValues":["US","ES","GB"]},{"name":"referrer","type":"string","description":"The referring URL","required":true,"exampleValues":["https://google.com",""]},{"name":"pathname","type":"string","description":"The current page pathname","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"href","type":"string","description":"The full URL of the page","required":true,"exampleValues":["https://www.tinybird.co/docs/forward/get-started/quick-start"]},{"name":"utm_source","type":"string","description":"Current session UTM source parameter from the landing URL","required":false,"exampleValues":["google","newsletter","twitter"]},{"name":"utm_medium","type":"string","description":"Current session UTM medium parameter from the landing URL","required":false,"exampleValues":["cpc","email","social"]},{"name":"utm_campaign","type":"string","description":"Current session UTM campaign parameter from the landing URL","required":false,"exampleValues":["spring_launch","product_update"]},{"name":"utm_content","type":"string","description":"Current session UTM content parameter from the landing URL","required":false,"exampleValues":["hero_cta","sidebar_link"]},{"name":"utm_term","type":"string","description":"Current session UTM term parameter from the landing URL","required":false,"exampleValues":["real-time analytics","data pipeline"]},{"name":"ft_source","type":"string","description":"First-touch UTM source from the user's very first visit with UTM parameters","required":false,"exampleValues":["google","producthunt"]},{"name":"ft_medium","type":"string","description":"First-touch UTM medium from the user's very first visit with UTM parameters","required":false,"exampleValues":["cpc","referral"]},{"name":"ft_campaign","type":"string","description":"First-touch UTM campaign from the user's very first visit with UTM parameters","required":false,"exampleValues":["launch_2025","awareness"]},{"name":"ft_content","type":"string","description":"First-touch UTM content from the user's very first visit with UTM parameters","required":false,"exampleValues":["hero_cta","banner"]},{"name":"ft_term","type":"string","description":"First-touch UTM term from the user's very first visit with UTM parameters","required":false,"exampleValues":["streaming analytics","clickhouse alternative"]},{"name":"ft_referrer","type":"string","description":"The referring URL from the user's very first visit, stored alongside first-touch UTMs","required":false,"exampleValues":["https://google.com","https://news.ycombinator.com"]}]},{"name":"$pageview","enumKey":"PAGEVIEW","category":"core","categoryName":"Core Events","description":"Standard PostHog pageview event for analytics and session tracking.","trigger":"Fires on every page navigation via Next.js router.","pages":["all"],"sections":[],"properties":[{"name":"$current_url","type":"string","description":"The full URL of the current page (PostHog standard)","required":true,"exampleValues":["https://www.tinybird.co/docs/forward/get-started/quick-start"]},{"name":"referrer","type":"string","description":"The referring URL","required":true,"exampleValues":["https://google.com",""]}]},{"name":"web_vital","enumKey":"WEB_VITAL","category":"performance","categoryName":"Performance Events","description":"Tracks Core Web Vitals metrics (CLS, FCP, INP, LCP, TTFB) for performance monitoring.","trigger":"Fires when web-vitals library reports a metric, with reportAllChanges for CLS, LCP, INP.","pages":["all"],"sections":[],"properties":[{"name":"name","type":"string","description":"The name of the web vital metric","required":true,"exampleValues":["LCP","FCP","CLS","INP","TTFB"]},{"name":"value","type":"number","description":"The metric value in milliseconds or unitless (CLS)","required":true,"exampleValues":["1234.56","0.05"]},{"name":"delta","type":"number","description":"The change in value since last measurement","required":true,"exampleValues":["100.5","0.01"]},{"name":"rating","type":"string","description":"Performance rating based on thresholds","required":true,"exampleValues":["good","needs-improvement","poor"]},{"name":"id","type":"string","description":"Unique identifier for this metric instance","required":true,"exampleValues":["v3-1234567890123-1234567890123"]},{"name":"navigationType","type":"string","description":"Type of navigation that triggered the metric","required":true,"exampleValues":["navigate","reload","back-forward","prerender"]},{"name":"pathname","type":"string","description":"The current page pathname","required":true,"exampleValues":["/forward/get-started"]},{"name":"href","type":"string","description":"The full URL of the page","required":true,"exampleValues":["https://www.tinybird.co/docs/forward/get-started"]},{"name":"user-agent","type":"string","description":"Browser user agent string","required":true,"exampleValues":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"]},{"name":"locale","type":"string","description":"User's browser locale","required":true,"exampleValues":["en-US"]},{"name":"location","type":"string","description":"User's country based on timezone","required":true,"exampleValues":["US"]},{"name":"referrer","type":"string","description":"The referring URL","required":true,"exampleValues":["https://google.com"]}]},{"name":"live_mode_on","enumKey":"LIVE_MODE_ON","category":"live","categoryName":"Live Stream Events","description":"Tracks when a live stream becomes active and the PiP video widget appears.","trigger":"Fires when getCurrentLive() returns a live stream and user hasn't closed the widget.","pages":["all"],"sections":["pip-widget"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]}]},{"name":"live_mode_close","enumKey":"LIVE_MODE_CLOSE","category":"live","categoryName":"Live Stream Events","description":"Tracks when a user closes the PiP live video widget.","trigger":"Fires when user clicks the close button on the PiP widget.","pages":["all"],"sections":["pip-widget"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]}]},{"name":"live_mode_go_to","enumKey":"LIVE_MODE_GO_TO","category":"live","categoryName":"Live Stream Events","description":"Tracks when a user clicks the PiP widget to navigate to the live page.","trigger":"Fires when user clicks the PiP widget (not close or play).","pages":["all"],"sections":["pip-widget"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]}]},{"name":"pip_video_clicked","enumKey":"PIP_VIDEO_CLICKED","category":"live","categoryName":"Live Stream Events","description":"Tracks when a user clicks to play the PiP live video.","trigger":"Fires when user clicks the play button on the PiP video.","pages":["all"],"sections":["pip-widget"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]}]},{"name":"announcement_bar_dismiss","enumKey":"ANNOUNCEMENT_BAR_DISMISS","category":"ui","categoryName":"UI Interaction Events","description":"Tracks when a user dismisses the announcement bar toast.","trigger":"Fires when user clicks the close button on the announcement bar.","pages":["all"],"sections":["announcement-bar"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"announcement_id","type":"string","description":"Unique identifier for the announcement (CONFIG.id)","required":true,"exampleValues":["launch-week-2026-03"]},{"name":"announcement_title","type":"string","description":"Title text of the announcement (CONFIG.title)","required":true,"exampleValues":["⏩️ A new Forward experience for the agentic era"]}]},{"name":"announcement_bar_link_clicked","enumKey":"ANNOUNCEMENT_BAR_LINK_CLICK","category":"ui","categoryName":"UI Interaction Events","description":"Tracks when a user clicks the announcement bar link to navigate to the linked content.","trigger":"Fires when user clicks anywhere on the announcement bar card.","pages":["all"],"sections":["announcement-bar"],"properties":[{"name":"page_path","type":"string","description":"Current page URL path (auto-injected by tracking context)","required":true,"exampleValues":["/forward/get-started/quick-start","/classic/overview"]},{"name":"announcement_id","type":"string","description":"Unique identifier for the announcement (CONFIG.id)","required":true,"exampleValues":["launch-week-2026-03"]},{"name":"announcement_title","type":"string","description":"Title text of the announcement (CONFIG.title)","required":true,"exampleValues":["⏩️ A new Forward experience for the agentic era"]},{"name":"link_url","type":"string","description":"Destination URL of the announcement link (CONFIG.buttonLink)","required":true,"exampleValues":["https://www.tinybird.co/launch-week"]}]}],"sharedComponents":[{"name":"Search","events":["docs_search"],"usedOn":["all"]},{"name":"PageView","events":["page_hit","$pageview"],"usedOn":["all"]},{"name":"WebVitalsTracking","events":["web_vital"],"usedOn":["all"]},{"name":"AnnouncementBar","events":["announcement_bar_dismiss","announcement_bar_link_clicked"],"usedOn":["all"]},{"name":"LiveContext","events":["live_mode_on","live_mode_close","live_mode_go_to","pip_video_clicked"],"usedOn":["all"]},{"name":"FeedbackForm","events":["feedback_submitted"],"usedOn":["/forward/*","/classic/*"]},{"name":"SlackForm","events":["form_submitted"],"usedOn":["/community"]}]}