@tekibo/feedpulse-sdk 2.0.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -50
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,33 +21,9 @@ The SDK automatically tracks:
|
|
|
21
21
|
- `scroll_into_view`: when tagged elements enter viewport
|
|
22
22
|
- `feedback`: explicit rating/message submissions from widget or manual API
|
|
23
23
|
|
|
24
|
-
Each event includes context such as session id, visitor id, page path, device, browser, OS, metadata, and timestamp.
|
|
25
|
-
|
|
26
|
-
## Backend requirements
|
|
27
|
-
|
|
28
|
-
Your backend must expose an ingest endpoint compatible with this payload:
|
|
29
|
-
|
|
30
|
-
```json
|
|
31
|
-
{
|
|
32
|
-
"events": [
|
|
33
|
-
{
|
|
34
|
-
"projectApiKey": "fp_live_xxx",
|
|
35
|
-
"elementId": "hero-cta",
|
|
36
|
-
"eventType": "click",
|
|
37
|
-
"sessionId": "session-1",
|
|
38
|
-
"visitorId": "visitor-1",
|
|
39
|
-
"page": "/",
|
|
40
|
-
"device": "desktop",
|
|
41
|
-
"metadata": {},
|
|
42
|
-
"timestamp": "2026-03-12T00:00:00.000Z"
|
|
43
|
-
}
|
|
44
|
-
]
|
|
45
|
-
}
|
|
46
|
-
```
|
|
47
24
|
|
|
48
|
-
In the FeedPulse codebase, the default server endpoint is:
|
|
49
25
|
|
|
50
|
-
|
|
26
|
+
|
|
51
27
|
|
|
52
28
|
## Quick start (Nuxt)
|
|
53
29
|
|
|
@@ -150,31 +126,6 @@ Nuxt and React widgets support:
|
|
|
150
126
|
- `placeholder?: string` prompt text
|
|
151
127
|
- `position?: "bottom-right" | "bottom-left" | "inline"` default is `"bottom-right"`
|
|
152
128
|
|
|
153
|
-
## Endpoint override
|
|
154
|
-
|
|
155
|
-
Use this when sending to staging/self-hosted backend:
|
|
156
|
-
|
|
157
|
-
### Nuxt
|
|
158
|
-
|
|
159
|
-
```vue
|
|
160
|
-
<FeedPulseProvider
|
|
161
|
-
api-key="fp_live_your_project_key"
|
|
162
|
-
endpoint="https://staging.your-domain.com/api/ingest"
|
|
163
|
-
>
|
|
164
|
-
<NuxtPage />
|
|
165
|
-
</FeedPulseProvider>
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### React
|
|
169
|
-
|
|
170
|
-
```tsx
|
|
171
|
-
<FeedPulseProvider
|
|
172
|
-
apiKey="fp_live_your_project_key"
|
|
173
|
-
endpoint="https://staging.your-domain.com/api/ingest"
|
|
174
|
-
>
|
|
175
|
-
{children}
|
|
176
|
-
</FeedPulseProvider>
|
|
177
|
-
```
|
|
178
129
|
|
|
179
130
|
## Integration checklist for your app
|
|
180
131
|
|