eagle-eye-track-sdk

鹰眼前端埋点采集sdk使用方法:

// 推荐：通过main.js模块化引入
import { EagleEye } from 'eagle-eye-track-sdk'

window.eagleEye = new EagleEye({
  appKey: process.env.VUE_APP_TRACK_ID, // 传入网站标识，请通过系统创建
  baseUrl: process.env.VUE_APP_TRACK_API  // api部署路径
})

或者以下方式引入

<!-- 在header中通过script标签引入 -->
<script async defer data-host-url="<%= process.env.VUE_APP_TRACK_API %>" data-website-id="<%= process.env.VUE_APP_TRACK_ID %>" src="./lib/js/tracker.js"></script>

Options 配置

参数	类型	说明	必填
appKey	string	网站唯一标识	是
offlineMode	boolean	是否离线模式
ignoreReferrers	Array<string>	忽略referrer
deviceId	string	设备唯一标识
doNotTrack	boolean	禁止采集
autoTrack	boolean	自动采集
useCssEvents	boolean	使用CSS Class事件埋点
baseUrl	string	api部署路径
whiteList	string | string[]	白名单站点列表
ignoreList	string | string[]	忽略站点列表

事件方法

事件	参数	说明	备注
trackEvent	(eventName: string, eventSegments: EventSegments) => void	添加事件
trackPageview	(page?: string | string[] | null, ignoreList?: string[], viewSegments?: ViewPayload) => void	添加pageView
trackOrientation	(orientation?: 'landscape' | 'portrait') => void	添加横竖屏
trackUser	(userSegments: UserPayload) => void	绑定用户信息

interface EventSegments {
  type?: string
  tagName?: string
  isTrusted?: boolean
  x?: number
  y?: number
  view?: string
  params?: object
}

interface ViewPayload {
  appVersion?: string
  ua?: string
  screen?: string
  devicePixelRatio?: number
  language?: string
  referrer?: string
  hostname?: string
  name?: string
  visit?: number
  url?: string
  orientation?: 'landscape' | 'portrait'
  view?: string
  start?: number
}

interface UserPayload {
  email?: string
  phoneNumber?: string
  staffCode?: string
  staffName?: string
  remark?: string
  role?: string
  deptmentId?: string
  deptmentName?: string
  deptmentSecId?: string
  deptmentSecName?: string
  deptmentThrId?: string
  deptmentThrName?: string
  gender?: string
  positionId?: string
  positionName?: string
  staffType?: string
  stat?: string
  workplace?: string
  signName?: string
}