Collect an analytics event

Ingest one analytics event. The endpoint is fire-and-forget: validation errors, excluded IPs, excluded paths, disabled tracking on the site, and localhost origins all return 202 with a descriptive `message`. This is by design to avoid client-side error noise. The body field set follows the `collectAnalyticsValidator` schema (event name, page path, optional properties).

POST/analytics/collect
Base URLhttps://api.lynkow.com/public/{siteId}

Request bodyrequired

  • osunion
  • clsunion
  • fidunion
  • inpunion
  • lcpunion
  • ttfbunion
  • browserunion
  • click_xunion
  • click_yunion
  • form_idunion
  • is_exitboolean

    Boolean

  • visibleboolean

    Boolean

  • file_urlunion
  • is_entryboolean

    Boolean

  • languageunion
  • page_urlstring

    Max 2048 characters

  • timezoneunion
  • utm_termunion
  • file_nameunion
  • form_nameunion
  • page_pathstringrequired

    Required. Max 1024 characters

  • event_timestringrequired

    Required

  • event_typeenumrequired

    Required. One of: pageview, scroll, time_on_page, cwv, exit, heartbeat, click, outbound_link, file_download, email_click, phone_click, rage_click, dead_click, copy, form_start, form_submit, form_abandon, form_field, form_error, heatmap_click

    One of: pageviewscrolltime_on_pagecwvexitheartbeatclickoutbound_linkfile_downloademail_clickphone_clickrage_clickdead_clickcopyform_startform_submitform_abandonform_fieldform_errorheatmap_click

  • field_nameunion
  • field_timeunion
  • field_typeunion
  • os_versionunion
  • page_titlestring

    Max 500 characters

  • session_idstringrequired

    Required

  • utm_mediumunion
  • utm_sourceunion
  • visitor_idstringrequired

    Required. 8-64 characters

  • click_countunion
  • copied_textunion
  • device_typeunion
  • utm_contentunion
  • engaged_timeunion
  • screen_widthunion
  • scroll_depthunion
  • time_on_pageunion
  • utm_campaignunion
  • click_elementunion
  • error_messageunion
  • page_referrerunion
  • screen_heightunion
  • file_extensionunion
  • traffic_sourceunion
  • viewport_widthunion
  • browser_versionunion
  • referrer_domainunion
  • scroll_behaviorunion
  • viewport_heightunion
  • click_element_idunion
  • click_target_urlunion
  • max_scroll_depthunion
  • click_element_tagunion
  • cookie_visitor_idunion
  • visitor_id_sourceenum

    One of: cookie, fingerprint, hybrid

    One of: cookiefingerprinthybrid

  • click_element_textunion
  • click_element_classunion
  • form_completion_rateunion
Feedback

Was this page helpful?