Web SDK

Déanann an Kixo Web SDK cliceanna, amhairc leathanaigh, seisiúin, earráidí, doimhneacht scrollaithe, web vitals, rage-clicks, dead-clicks agus sonraí heatmap a rianú go huathoibríoch le leabú aonlíne. Tá monatóireacht ar iarratais líonra ar fáil mar shuíomh roghnach. Dáiltear é mar mhodúl dúchasach ES agus oibríonn sé i mbrabhsálaithe nua-aimseartha.

Suiteáil

Clib script (CDN)

Cuir an blúire roimh an gclib dhúnta </head>. Tabhair faoi deara an type="module" — tá sé riachtanach mar gur modúl ES é an SDK. Déantar code-split ar session replay ina chuid taifeadta a mheaitseálann an leagan agus nach lódáiltear go dtí go gcumasaítear replay, mar sin fanann an bundail bhunúsach beag fad atá replay múchta.

html

<script
  type="module"
  src="https://cdn.kixo.io/kixo.min.js?project_id=YOUR_PROJECT_ID&api_key=YOUR_API_KEY">
</script>

Nóta

Léann an SDK project_id agus api_key ó URL na scripte agus tosaíonn sé é féin. Chun roghanna a chumrú i gcód an fheidhmchláir, bain na paraiméadair URL agus glaoigh ar Kixo.init({...}) ina n-áit — bíonn an réad domhanda Kixo ar fáil nuair a bheidh an modúl luchtaithe.

html

<script type="module" src="https://cdn.kixo.io/kixo.min.js"></script>
<script type="module">
  Kixo.init({
    projectId: 'YOUR_PROJECT_ID',
    apiKey:    'YOUR_API_KEY',
  });
</script>

npm

Úsáid é seo nuair is mian leat roghanna a chumrú i gcód an fheidhmchláir seachas trí URL na scripte. Nochtann sé an API Kixo céanna leis an leabú CDN.

bash

npm install @kixo.io/web

import Kixo from '@kixo.io/web';

Kixo.init({
  projectId: 'YOUR_PROJECT_ID',
  apiKey: 'YOUR_API_KEY',
});

Ardáin gan chód

Má tá tú ag tógáil le tógálaí atá faoi thiomáint AI, mar shampla Lovable, Bolt, v0, nó Replit, greamaigh an blúire script-tag go díreach isteach i socruithe comhrá nó insteallta cóid an tógálaí. Tacaíonn formhór na dtógálaithe le scripteanna a chur le <head> do shuímh.

Cumraíocht

Úsáideann an leabú dhá líne na réamhshocruithe anailíse áitiúla thíos. Fanann monatóireacht ar iarratais mar rogha isteach. Níl athsheinm seisiúin san áireamh in Kixo.init() d’aon ghnó: ón bpainéal tionscadail amháin a thagann an lasc cumasaithe, an tsampláil, na socruithe príobháideachais, an fad agus na socruithe gabhála.

Kixo.init({
  projectId: 'YOUR_PROJECT_ID',     // required
  apiKey:    'YOUR_API_KEY',         // required

  // Per-tracker toggles — all default to true except network.
  autoTrack: {
    pageViews:   true,
    clicks:      true,
    scrollDepth: true,
    sessions:    true,
    forms:       true,
    network:     false,     // opt in only when you need request telemetry
    errors:      true,
    performance: true,
    rageClicks:  true,
    deadClicks:  true,
  },

  // Heatmap recording (clicks + scroll on by default; mouse-move opt-in).
  heatmap: {
    enabled: true,
    clicks:  true,
    moves:   false,
    scroll:  true,
  },

});

Nóta

Cumraíocht faoi rialú an tionscadail. Is féidir le socruithe Dashboard rianairí áitiúla anailísíochta a dhíchumasú. Níl aon bhratach áitiúil dhearfach chumasaithe ag Replay ar chor ar bith: cumraigh faoi Settings → Session replay é, agus leanann an SDK an beartas tionscadail is déanaí ag an gcéad athnuachan cumraíochta eile.

Imeachtaí uathrianaithe

Leis an gcumraíocht réamhshocraithe, gabhann Kixo na himeachtaí seo go huathoibríoch gan aon chód breise:

page_view — gach loingseoireacht (luchtú tosaigh + athruithe bealaigh SPA)
session_start / session_end
click — gach idirghníomhú cliceála leis an roghnóir eiliminte
scroll_depth — tairseacha 25 / 50 / 75 / 100 %
rage_click — cliceálacha arís agus arís eile ar an eilimint chéanna
dead_click — cliceálacha ar eilimintí neamhidirghníomhacha
error — eisceachtaí JavaScript gan ghabháil + diúltuithe promise
performance — méadrachtaí luchtaithe leathanaigh agus Web Vitals (LCP, FCP, FID, CLS, INP, TTFB)
network_request — uainiú roghnach iarratas nuair atá rianú líonra cumasaithe
heatmap_click / scroll — sonraí mapa teasa

Féach an liosta iomlán sa Tagairt d’imeachtaí.

Imeachtaí saincheaptha

Kixo.track()

Seol imeacht saincheaptha le hairíonna roghnacha.

Kixo.track('purchase_completed', {
  product_id: 'SKU-123',
  amount: 49.99,
  currency: 'USD',
});

Cúntóirí imeachta clóscríofa

Áis áise os cionn Kixo.track() do na himeachtaí a aithníonn Kixo de réir ainm (purchase, signup, subscribe_start, trial_start, cancel, upgrade, activation, share, invite). Tugann na fillteáin chlóscríofa bailíochtú airíonna ag am tiomsaithe agus foinse amháin fírinne d’ainmneacha eochracha — meaitseálann brathadóir imeachtaí caighdeánacha an chúilchórais go litriúil iad.

Kixo.trackPurchase({ amount: 49.99, currency: 'USD', productId: 'pro_yearly' });

Kixo.trackSubscriptionStart({
  plan: 'pro',
  amount: 9.99,
  currency: 'USD',
  interval: 'month',
});

Kixo.trackSignup({ method: 'google' });
Kixo.trackTrialStart({ plan: 'pro', days: 14 });
Kixo.trackCancel({ plan: 'pro', reason: 'too_expensive' });
Kixo.trackUpgrade({ fromPlan: 'free', toPlan: 'pro' });
Kixo.trackActivation({ event: 'first_post_published' });
Kixo.trackShare({ channel: 'twitter', contentId: 'post_123' });
Kixo.trackInvite({ channel: 'email', recipientCount: 5 });

Kixo.identify()

Ceangail an gléas reatha le húsáideoir aitheanta. Bíonn réimír $ ar eochracha caighdeánacha in áirithe (gnás Mixpanel), rud a scarann iad ó do thréithe saincheaptha féin agus a chuireann chun cinn iad chuig colúin phróifíle na deaise — féach an Catalóg chaighdeánach na n-airíonna thíos don liosta iomlán de 37 eochair.

Kixo.identify('user_123', {
  $email:  'jane@example.com',     // identity
  $name:   'Jane Doe',              // identity
  $plan:   'pro',                   // subscription pack
  $lifetime_orders: 12,             // e-commerce pack
  signup_source: 'twitter_ad',      // custom trait
});

Kixo.setUserProperty() — clibeáil úsáideoir le haghaidh deighilte

Ceangail tréithe treallacha eochair/luacha leis an úsáideoir reatha. Is féidir leis na luachanna a bheith ina dteaghráin, ina n-uimhreacha, nó ina booles — is é an fhoirm bhoole an bealach is glaine chun úsáideoir a clib le haghaidh dírithe níos déanaí i ndeighleoga, i bhfeachtais ríomhphoist, nó i bhfiosruithe comhrá.

// Tag a user as subscribed — instant segment "Subscribed users"
Kixo.setUserProperty('subscribe', true);

// Mark a VIP — used in campaign targeting + chat ("show me VIPs")
Kixo.setUserProperty('vip', true);

// Numeric and string values work too
Kixo.setUserProperty('plan_tier', 'enterprise');
Kixo.setUserProperty('lifetime_orders', 42);

// Bulk-set
Kixo.setUserProperties({ subscribe: true, plan_tier: 'enterprise' });

Coimeádtar na hairíonna in localStorage trasna athlódálacha agus gabhann siad go huathoibríoch leis na himeachtaí ina dhiaidh sin. Úsáid iad sa chomhrá le leideanna mar "tóg feachtas ríomhphoist d’úsáideoirí ina bhfuil subscribe fíor" — déanann Kixo deighleog a chur le chéile agus dréacht den teimpléad a ghiniúint go huathoibríoch. Glantar iad ar Kixo.reset().

Kixo.group()

Ceangail an t-úsáideoir le cuideachta nó eagraíocht.

Kixo.group('company_456', {
  name: 'Acme Inc',
  plan: 'enterprise',
});

Kixo.reset()

Glan an t-aitheantas, na sár-airíonna, agus an scuaine mharthanach. Glaoigh air seo ag logáil amach ionas nach sannfar imeachtaí ina dhiaidh sin don úsáideoir roimhe sin.

Kixo.reset();

Catalóg chaighdeánach na n-airíonna

Bíonn réimír $ ar eochracha airíonna forchoimeádta ionas go bhfanann siad i spás ainmneacha ar leithligh ó do thréithe saincheaptha. Clúdaíonn catalóg Kixo 37 eochair thar 3 phacáiste uilíocha (aitheantas, geo, saolré) agus 5 phacáiste ingearacha B2B (síntiús, ríomhthráchtáil, meáin, margadh, dílseacht). Socraigh na cinn a bhaineann le do tháirge — oiriúnaíonn an painéal agus ní thaispeánann sé ach na pacáistí a líonann tú.

Aitheantas

Baineann sé i gcónaí. Socraíonn sé colúin cheanntásc an phróifíle.

Eochair	Cineál	Cur síos
`$email`	teaghrán	An príomhsheoladh ríomhphoist, agus is minic gurb é an eochair chumaisc é le haghaidh fuaite aitheantais.
`$phone`	teaghrán	Uimhir theileafóin E.164.
`$name`	teaghrán	Ainm taispeána iomlán.
`$first_name`	teaghrán	Ainm baiste.
`$last_name`	teaghrán	Sloinne.
`$avatar_url`	teaghrán	URL iomlán chuig íomhá avatar an úsáideora.

Geo

Comhthéacs geografach.

Eochair	Cineál	Cur síos
`$country`	teaghrán	Cód tíre de réir ISO 3166.
`$city`	teaghrán	Ainm cathrach.
`$region`	teaghrán	Stát nó cúige.
`$timezone`	teaghrán	Crios IANA ar nós `America/Los_Angeles`.
`$language`	teaghrán	Clib IETF ar nós `en` nó `ru-RU`.
`$locale`	teaghrán	Aitheantóir locale iomlán.

Saolré

Cathain a chonaiceamar iad.

Eochair	Cineál	Cur síos
`$created`	ISO8601	Am clárúcháin nó cruthaithe cuntais.
`$last_seen`	ISO8601	An t-am rannpháirtíochta is déanaí.

Síntiús

Socraigh é seo má tá pleananna ag do tháirge.

Eochair	Cineál	Cur síos
`$plan`	teaghrán	Slug sraithe — `free`, `pro`, `enterprise`.
`$subscription_status`	teaghrán	`active` / `trial` / `cancelled` / `past_due`.
`$trial_ends`	ISO8601	Cathain a rachaidh an triail reatha in éag.
`$mrr`	uimhir	Ioncam athfhillteach míosúil in airgeadra an chuntais.
`$subscription_started`	ISO8601	Cathain a thosaigh an síntiús reatha.

Ríomhthráchtáil

Socraigh é seo má dhíolann tú táirgí.

Eochair	Cineál	Cur síos
`$lifetime_orders`	uimhir	Líon na n-orduithe críochnaithe.
`$lifetime_revenue`	uimhir	Caiteachas iomlán.
`$aov`	uimhir	Meánluach an ordaithe.
`$last_purchase`	ISO8601	An ceannach rathúil is déanaí.
`$first_purchase`	ISO8601	An chéad cheannach rathúil.
`$cart_abandoned_count`	uimhir	Líon iomlán na dtréigean ciseáin.

Meáin

Socraigh é seo má fhoilsíonn tú ábhar.

Eochair	Cineál	Cur síos
`$content_tier`	teaghrán	`free` / `premium` / `paid`.
`$subscribed_categories`	Teaghrán CSV nó eagar	Catagóirí a leanann an t-úsáideoir.
`$watch_time_total`	uimhir	An t-am faire iomlán i soicindí.
`$last_played`	ISO8601	An tús athsheinm is déanaí.

Margadh

Socraigh é seo más ardán déthaobhach thú.

Eochair	Cineál	Cur síos
`$seller_tier`	teaghrán	Slug na sraithe ar thaobh an díoltóra.
`$buyer_tier`	teaghrán	Slug leibhéil ar thaobh an cheannaitheora.
`$listings_count`	uimhir	Liostuithe gníomhacha atá ag an úsáideoir.
`$reviews_count`	uimhir	Na léirmheasanna a fuair an t-úsáideoir.
`$verified`	boole	Stádas KYC.

Dílseacht

Socraigh é seo do chláir rannpháirtíochta agus luaíochtaí.

Eochair	Cineál	Cur síos
`$loyalty_points`	uimhir	Iarmhéid reatha pointí infhuascailte.
`$vip_level`	teaghrán	Slug sraithe VIP.
`$referral_count`	uimhir	Atreoruithe rathúla curtha i leith an úsáideora seo.

Leid

Nach bhfeiceann tú do phatrún? Úsáid eochracha loma do thréithe saincheaptha. Beidh siad le feiceáil i bpainéal Custom Traits na deaise gan colúin an phróifíle a thruailliú. Is buillí tuairime iad na 5 phacáiste ingearacha thuas faoi na cruthanna B2B is coitianta — fanann téarmaíocht atá sonrach don chustaiméir (m.sh. shipping_plan) lom.

Sár-airíonna

Péirí eochrach/luacha in aghaidh an tseisiúin a ghabhann go huathoibríoch le gach imeacht amach. Tá siad difriúil ó thréithe identify() (a chuireann síos ar an aitheantas); cuireann sár-airíonna síos ar chomhthéacs an tseisiúin — malairt ghníomhach A/B, cineál build, bratacha gné ar roghnaíodh isteach iontu, tag cleamhnaithe. Coimeádtar iad in localStorage trasna athlódálacha; glantar iad ar reset(). Má thagann eochracha salach ar a chéile, bíonn properties in aghaidh an imeachta ar track() i réim i gcónaí.

Kixo.setSuperProperty('build_flavor', 'beta');
Kixo.setSuperProperties({ ab_variant: 'B', referrer_campaign: 'autumn-launch' });

// Sugar for A/B tracking — keys as 'experiment_<id>' so backend
// can run direct WHERE filters on experiment analysis.
Kixo.setExperimentVariant('checkout_v2', 'variant_a');

Kixo.unsetSuperProperty('build_flavor');
Kixo.clearSuperProperties();

Léarscáileanna teasa

Tá taifeadadh mapaí teasa ar siúl de réir réamhshocraithe — cliceálacha agus doimhneacht scrollaithe, sampláilte ag 100 % araon. Is rogha shonrach isteach é gluaiseacht na luiche (toirt ard; cumasaigh de réir leathanaigh más fiú é).

Kixo.init({
  projectId: 'YOUR_PROJECT_ID',
  apiKey:    'YOUR_API_KEY',
  heatmap:   { moves: true },  // turn on full-resolution mouse-move
});

Athsheinm seisiúin

Taifeadann athsheinm seisiúin léargas DOM agus sruth sóchán rrweb ionas gur féidir leis an bpainéal an leathanach a atógáil mar sheisiún inscroite taobh leis an rian imeachtaí. Atógáil DOM atá ann, ní taifeadadh físe den scáileán. Tá Athsheinm múchta de réir réamhshocraithe. Cumasaigh é don tionscadal faoi Deais → Socruithe → Athsheinm seisiúin; ní gá aon athrú ar chód an fheidhmchláir. Nuair a chumasaítear é, íoslódáiltear an taifeadán ó mhír ar leith a mheaitseálann an leagan tar éis Athsheinm a chumasú.

Nóta

Is é an painéal foinse na fírinne. Socraigh Enable replay, Mask inputs, an fad uasta, agus na hardrialuithe gabhála ansin. Stóráiltear captureOnCellular sa bheartas tionscadail céanna do iOS agus Android; ní nochtann brabhsálaithe comhartha iontaofa Wi‑Fi i gcoinne ceallach, mar sin tuairiscíonn an Web SDK an srian sin atá dúchasach amháin agus déanann sé neamhaird de.

Cad a mhascáiltear

Tá Athsheinm deartha le bheith sábháilte le cumasú. Cosnaíonn trí shraith an t-ábhar íogair, agus bíonn siad uile ar siúl de réir réamhshocraithe:

Tá mascáil ionchuir á rialú ag an tionscadal — fad atá socrú Mascáil ionchur sa Dashboard ar siúl (an réamhshocrú), cuirtear réiltíní in ionad carachtair a chlóscríobhtar sula bhfágann siad an brabhsálaí. Ná múch é ach do riachtanas sonrach ísealíogaireachta; fanann réimsí aitheantais, fíordheimhnithe agus íocaíochta faoi mhasc fós.
An aitreabúid data-kixo-mask cuireann bac ar eilimint agus ar a fochrann iomlán. Cuir ar aon choimeádán é a bhféadfadh ábhar pearsanta nó rúnda a bheith ann; taispeántar sealbhóir áite san athsheinm, ní téacs ná ábhar DOM an fhochrainn sin.
html
```
<div data-kixo-mask>
  
  
</div>
```
Bíonn réimsí íogaire mascáilte i gcónaí — cuirtear masc ar ionchuir a bhfuil cuma pasfhocail, uimhir chárta, CVV, SSN, rún, nó token orthu (de réir cineáil, ainm, id, nó autocomplete) fiú má tá socrú Mascáil ionchur an tionscadail múchta. Téann téacs infheicthe agus tréithe sraitheacha DOM trí shláintitheoir PII Kixo freisin sula n-uaslódáiltear iad.

Bailiú sonraí

Gabhann an SDK na lorgairí atá cumasaithe i do shocruithe comhtháthaithe agus tionscadail, chomh maith leis na himeachtaí agus na hairíonna a sheolann d’fheidhmchlár.

Cá dtéann na taifeadtaí

Comhbhrúnn an SDK imeachtaí rrweb le gzip i ndeighleoga teoranta, iarrann sé ar Kixo URL uaslódála sínithe laistigh de raon an tionscadail, agus uaslódálann sé na deighleoga sin go díreach chuig stóras na hAthsheinme. Oscail an seisiún atógtha faoi Athsheinm → Seisiúin; nascann sé le rian anailíse an tseisiúin chéanna.

Nóta

Tá Athsheinm faoi réir do phlean. Braitheann líon na seisiún a ghabhtar agus a choimeádtar ar phlean do thionscadail; ar na leibhéil níos ísle, taifeadann Kixo meiteashonraí seisiúin éadrom fós ionas go mbeidh an seisiún le feiceáil i do liostaí agus in anailísíocht.

Bratacha gné

Seiceáil luachanna na mbratacha ag am rite le Kixo.getFeatureFlag().

const variant = Kixo.getFeatureFlag('new_checkout');

if (variant === 'enabled') {
  showNewCheckout();
} else {
  showLegacyCheckout();
}

Seachadadh agus iompar as líne

Cuireann an SDK imeachtaí i scuaine go háitiúil, seolann sé i mbaisceanna iad, agus déanann sé iarracht eile ar theipeanna sealadacha le backoff. Má chuirtear an bailiúchán ar sos ó shocruithe an tionscadail, ní sheolfar imeachtaí nua go dtí go gcumasófar an bailiúchán arís.

Diagnóisic

Léargas sláinte inléite amháin — úsáideach chun “cén fáth nach bhfuil mo chuid imeachtaí ag sreabhadh?” a dhífhabhtú sna huirlisí forbartha.

const diag = Kixo.diagnostics();
console.log(diag);