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 body
required

  • os
    union
  • cls
    union
  • fid
    union
  • inp
    union
  • lcp
    union
  • ttfb
    union
  • browser
    union
  • click_x
    union
  • click_y
    union
  • form_id
    union
  • is_exit
    boolean

    Boolean

  • visible
    boolean

    Boolean

  • file_url
    union
  • is_entry
    boolean

    Boolean

  • language
    union
  • page_url
    string

    Max 2048 characters

  • timezone
    union
  • utm_term
    union
  • file_name
    union
  • form_name
    union
  • page_path
    string
    required

    Required. Max 1024 characters

  • event_time
    string
    required

    Required

  • event_type
    enum
    required

    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_name
    union
  • field_time
    union
  • field_type
    union
  • os_version
    union
  • page_title
    string

    Max 500 characters

  • session_id
    string
    required

    Required

  • utm_medium
    union
  • utm_source
    union
  • visitor_id
    string
    required

    Required. 8-64 characters

  • click_count
    union
  • copied_text
    union
  • device_type
    union
  • utm_content
    union
  • engaged_time
    union
  • screen_width
    union
  • scroll_depth
    union
  • time_on_page
    union
  • utm_campaign
    union
  • click_element
    union
  • error_message
    union
  • page_referrer
    union
  • screen_height
    union
  • file_extension
    union
  • traffic_source
    union
  • viewport_width
    union
  • browser_version
    union
  • referrer_domain
    union
  • scroll_behavior
    union
  • viewport_height
    union
  • click_element_id
    union
  • click_target_url
    union
  • max_scroll_depth
    union
  • click_element_tag
    union
  • cookie_visitor_id
    union
  • visitor_id_source
    enum

    One of: cookie, fingerprint, hybrid

    One of: cookiefingerprinthybrid

  • click_element_text
    union
  • click_element_class
    union
  • form_completion_rate
    union
Feedback

Was this page helpful?