You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/integrations/algolia.mdx
+31-2Lines changed: 31 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,12 @@ Search an Algolia index
50
50
|`page`| number | No | Page number to retrieve \(default: 0\)|
51
51
|`filters`| string | No | Filter string \(e.g., "category:electronics AND price < 100"\)|
52
52
|`attributesToRetrieve`| string | No | Comma-separated list of attributes to retrieve |
53
+
|`facets`| string | No | Comma-separated list of facet attribute names to retrieve counts for \(use "*" for all\)|
54
+
|`getRankingInfo`| boolean | No | Whether to include detailed ranking information in each hit |
55
+
|`aroundLatLng`| string | No | Coordinates for geo-search \(e.g., "40.71,-74.01"\)|
56
+
|`aroundRadius`| string | No | Maximum radius in meters for geo-search, or "all" for unlimited |
57
+
|`insideBoundingBox`| json | No | Bounding box coordinates as \[\[lat1, lng1, lat2, lng2\]\] for geo-search |
58
+
|`insidePolygon`| json | No | Polygon coordinates as \[\[lat1, lng1, lat2, lng2, lat3, lng3, ...\]\] for geo-search |
53
59
54
60
#### Output
55
61
@@ -200,6 +206,10 @@ Browse and iterate over all records in an Algolia index using cursor pagination
200
206
|`attributesToRetrieve`| string | No | Comma-separated list of attributes to retrieve |
201
207
|`hitsPerPage`| number | No | Number of hits per page \(default: 1000, max: 1000\)|
202
208
|`cursor`| string | No | Cursor from a previous browse response for pagination |
209
+
|`aroundLatLng`| string | No | Coordinates for geo-search \(e.g., "40.71,-74.01"\)|
210
+
|`aroundRadius`| string | No | Maximum radius in meters for geo-search, or "all" for unlimited |
211
+
|`insideBoundingBox`| json | No | Bounding box coordinates as \[\[lat1, lng1, lat2, lng2\]\] for geo-search |
212
+
|`insidePolygon`| json | No | Polygon coordinates as \[\[lat1, lng1, lat2, lng2, lat3, lng3, ...\]\] for geo-search |
203
213
204
214
#### Output
205
215
@@ -225,7 +235,7 @@ Perform batch add, update, partial update, or delete operations on records in an
225
235
|`applicationId`| string | Yes | Algolia Application ID |
226
236
|`apiKey`| string | Yes | Algolia Admin API Key |
227
237
|`indexName`| string | Yes | Name of the Algolia index |
228
-
|`requests`| json | Yes | Array of batch operations. Each item has "action" \(addObject, updateObject, partialUpdateObject, partialUpdateObjectNoCreate, deleteObject\) and "body" \(the record data, must include objectID for update/delete\)|
238
+
|`requests`| json | Yes | Array of batch operations. Each item has "action" \(addObject, updateObject, partialUpdateObject, partialUpdateObjectNoCreate, deleteObject, delete, clear\) and "body" \(the record data; must include objectID for update/delete; use an empty object \{\} for the index-level delete/clear actions\)|
229
239
230
240
#### Output
231
241
@@ -390,7 +400,7 @@ Delete all records matching a filter from an Algolia index
390
400
|`numericFilters`| json | No | Array of numeric filters \(e.g., \["price > 100"\]\)|
391
401
|`tagFilters`| json | No | Array of tag filters using the _tags attribute \(e.g., \["published"\]\)|
392
402
|`aroundLatLng`| string | No | Coordinates for geo-search filter \(e.g., "40.71,-74.01"\)|
393
-
|`aroundRadius`|number| No | Maximum radius in meters for geo-search, or "all" for unlimited |
403
+
|`aroundRadius`|string| No | Maximum radius in meters for geo-search, or "all" for unlimited |
394
404
|`insideBoundingBox`| json | No | Bounding box coordinates as \[\[lat1, lng1, lat2, lng2\]\] for geo-search filter |
395
405
|`insidePolygon`| json | No | Polygon coordinates as \[\[lat1, lng1, lat2, lng2, lat3, lng3, ...\]\] for geo-search filter |
396
406
@@ -401,4 +411,23 @@ Delete all records matching a filter from an Algolia index
401
411
|`taskID`| number | Algolia task ID for tracking the delete-by-filter operation |
402
412
|`updatedAt`| string | Timestamp when the operation was performed |
403
413
414
+
### `algolia_get_task_status`
415
+
416
+
Check whether an Algolia indexing task has finished publishing
417
+
418
+
#### Input
419
+
420
+
| Parameter | Type | Required | Description |
421
+
| --------- | ---- | -------- | ----------- |
422
+
|`applicationId`| string | Yes | Algolia Application ID |
423
+
|`apiKey`| string | Yes | Algolia API Key |
424
+
|`indexName`| string | Yes | Name of the Algolia index the task ran against |
425
+
|`taskID`| number | Yes | The taskID returned by a previous write operation |
426
+
427
+
#### Output
428
+
429
+
| Parameter | Type | Description |
430
+
| --------- | ---- | ----------- |
431
+
|`status`| string | Task status: "published" once the operation has been applied, "notPublished" while still pending |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/integrations/amplitude.mdx
+94-5Lines changed: 94 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
7
7
8
8
<BlockInfoCard
9
9
type="amplitude"
10
-
color="#1B1F3B"
10
+
color="#13294B"
11
11
/>
12
12
13
13
{/* MANUAL-CONTENT-START:intro */}
@@ -31,7 +31,7 @@ In Sim, the Amplitude integration enables powerful analytics automation scenario
31
31
32
32
## Usage Instructions
33
33
34
-
Integrate Amplitude into your workflow to track events, identify users and groups, search for users, query analytics, and retrieve revenue data.
34
+
Integrate Amplitude into your workflow to track events, identify users and groups, search for users, query analytics, analyze funnels and retention, and retrieve revenue data.
35
35
36
36
37
37
@@ -64,6 +64,7 @@ Track an event in Amplitude using the HTTP V2 API.
64
64
|`revenue`| string | No | Revenue amount |
65
65
|`productId`| string | No | Product identifier |
66
66
|`revenueType`| string | No | Revenue type \(e.g., "purchase", "refund"\)|
67
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
67
68
68
69
#### Output
69
70
@@ -86,6 +87,7 @@ Set user properties in Amplitude using the Identify API. Supports $set, $setOnce
86
87
|`userId`| string | No | User ID \(required if no device_id\)|
87
88
|`deviceId`| string | No | Device ID \(required if no user_id\)|
88
89
|`userProperties`| string | Yes | JSON object of user properties. Use operations like $set, $setOnce, $add, $append, $unset. |
90
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
89
91
90
92
#### Output
91
93
@@ -106,6 +108,7 @@ Set group-level properties in Amplitude. Supports $set, $setOnce, $add, $append,
106
108
|`groupType`| string | Yes | Group classification \(e.g., "company", "org_id"\)|
107
109
|`groupValue`| string | Yes | Specific group identifier \(e.g., "Acme Corp"\)|
108
110
|`groupProperties`| string | Yes | JSON object of group properties. Use operations like $set, $setOnce, $add, $append, $unset. |
111
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
109
112
110
113
#### Output
111
114
@@ -125,6 +128,7 @@ Search for a user by User ID, Device ID, or Amplitude ID using the Dashboard RES
|`user`| string | Yes | User ID, Device ID, or Amplitude ID to search for |
131
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
128
132
129
133
#### Output
130
134
@@ -149,6 +153,7 @@ Get the event stream for a specific user by their Amplitude ID.
149
153
|`offset`| string | No | Offset for pagination \(default 0\)|
150
154
|`limit`| string | No | Maximum number of events to return \(default 1000, max 1000\)|
151
155
|`direction`| string | No | Sort direction: "latest" or "earliest" \(default: latest\)|
156
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
152
157
153
158
#### Output
154
159
@@ -170,10 +175,12 @@ Get the event stream for a specific user by their Amplitude ID.
170
175
| ↳ `numSessions`| number | Total session count |
171
176
| ↳ `platform`| string | Primary platform |
172
177
| ↳ `country`| string | Country |
178
+
| ↳ `firstUsed`| string | Date the user first appeared |
179
+
| ↳ `lastUsed`| string | Date of most recent user activity |
173
180
174
181
### `amplitude_user_profile`
175
182
176
-
Get a user profile including properties, cohort memberships, and computed properties.
183
+
Get a user profile including properties, cohort memberships, and computed properties. Not available for EU data-residency projects.
177
184
178
185
#### Input
179
186
@@ -212,7 +219,12 @@ Query event analytics data with segmentation. Get event counts, uniques, average
212
219
|`metric`| string | No | Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula \(default: uniques\)|
213
220
|`interval`| string | No | Time interval: 1 \(daily\), 7 \(weekly\), or 30 \(monthly\)|
214
221
|`groupBy`| string | No | Property name to group by \(prefix custom user properties with "gp:"\)|
222
+
|`groupBy2`| string | No | Second property name to group by \(prefix custom user properties with "gp:"\)|
215
223
|`limit`| string | No | Maximum number of group-by values \(max 1000\)|
224
+
|`filters`| string | No | JSON array of filter objects applied to the event, e.g. \[\{"subprop_type":"event","subprop_key":"city","subprop_op":"is","subprop_value":\["San Francisco"\]\}\]|
225
+
|`formula`| string | No | Required when metric is "formula", e.g. "UNIQUES\(A\)/UNIQUES\(B\)" |
226
+
|`segment`| string | No | JSON segment definition\(s\) applied to the query |
227
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
216
228
217
229
#### Output
218
230
@@ -237,6 +249,9 @@ Get active or new user counts over a date range from the Dashboard REST API.
237
249
|`end`| string | Yes | End date in YYYYMMDD format |
238
250
|`metric`| string | No | Metric type: "active" or "new" \(default: active\)|
239
251
|`interval`| string | No | Time interval: 1 \(daily\), 7 \(weekly\), or 30 \(monthly\)|
252
+
|`groupBy`| string | No | Property name to group by |
253
+
|`segment`| string | No | JSON segment definition\(s\) applied to the query |
254
+
|`dataResidency`| string | No | Data residency region: "us" \(default\) or "eu" |
240
255
241
256
#### Output
242
257
@@ -256,6 +271,7 @@ Get real-time active user counts at 5-minute granularity for the last 2 days.
0 commit comments