Skip to content

Commit c36b659

Browse files
markzegarellitcgilbert
markzegarelli
and
tcgilbert
authored
Correcet folder name and source name (#4164) (#4165)
* Correcet folder name and source name * Add redirect and clean up tables --------- Co-authored-by: Thomas Gilbert <[email protected]>
1 parent d58c982 commit c36b659

File tree

2 files changed

+122
-123
lines changed
  • src/connections/sources/catalog/cloud-apps

2 files changed

+122
-123
lines changed

‎src/connections/sources/catalog/cloud-apps/foursquare-movement/index.md

Lines changed: 122 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,124 @@
11
---
22
title: 'Foursquare Movement Source'
3-
hidden: true
4-
---
3+
beta: true
4+
id: Eek5OnuA7e
5+
redirect_from:
6+
- /connections/sources/catalog/cloud-apps/foursquare-pilgrim/
7+
---
8+
{% include content/source-region-unsupported.md %}
9+
10+
[Foursquare's Movement SDK](https://location.foursquare.com/products/movement-sdk/) provides real-time event triggering based upon your users' location in the physical world, allowing you to harness FourSquare's powerful geotargeting capabilities to send those events to other services using Segment.
11+
12+
This destination is maintained by Foursquare. For any issues with the destination, [contact the Foursquare Developer Support team](mailto:[email protected]).
13+
14+
{% include content/beta-note.md %}
15+
16+
17+
## Getting Started
18+
19+
1. From the Segment web app, click **Catalog**.
20+
2. Search for "Foursquare Movement" in the Catalog, select it, and choose which of your sources to connect the it to.
21+
3. Once you save Foursquare Movement as a source, copy your "Write Key".
22+
4. Go to your [Foursquare Developer Console](https://foursquare.com/developers/apps/) and create a new Segment integration in your Foursquare app's Movement SDK console. There you can enter the Segment "Write Key" into the Segment Integration Configuration screen.
23+
24+
## Events
25+
26+
Below is a table of events that Foursquare's Movement SDK sends to Segment. These events will show up as tables in your warehouse, and as regular events in your other Destinations. Foursquare will send through the `userId` if available.
27+
28+
| Event Name | Description |
29+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| `placeArrival` | Device has arrived at a venue. Usually occurs after 3-7 minutes. |
31+
| `placeDeparture` | Device has left a visited venue. |
32+
| `placeHistorical` | Device previously arrived or departed a venue, but the device didn't have network connectivity at the time, but Foursquare lets you know as soon as they have connectivity again. |
33+
| `geofenceEnter` | Device has entered a venue, polygon or lat/lng geofence. |
34+
| `geofenceDwell` | Device has remained within geofence for pre-determined time. |
35+
| `geofenceVenueConfirmed` | Device has dwelled within geofence AND Foursquare thinks this is actually the venue the device is at. |
36+
| `geofenceExit` | Device has left geofence. |
37+
38+
39+
### Event Properties
40+
41+
Below are tables outlining the properties included in the events listed above.
42+
43+
#### Place Visit Event Properties
44+
45+
All fields are presented as strings.
46+
47+
| Property Name | Description | Values |
48+
| --------------------- | ------------------------------------------------------------------------------------------- | ------------------------------ |
49+
| `address` | Address of visit venue | String |
50+
| `city` | City of visit venue | String |
51+
| `confidence` | How likely Foursquare thinks it's correct | low, medium, high |
52+
| `country` | Country of visit venue | String |
53+
| `crossStreet` | Cross street of visit venue | String |
54+
| `lat` | Latitude of event | Double |
55+
| `lng` | Longitude of event | Double |
56+
| `locationType` | Indicates if Foursquare thinks this location is device's home or work, otherwise uses venue | work, home, venue |
57+
| `primaryCategoryId` | Foursquare Category ID of visit venue | String |
58+
| `primaryCategoryName` | Human readable category name of visit venue | String |
59+
| `state` | Abbreviation of state or province of visit venue | String |
60+
| `timestamp` | ISO 8601 timestamp of when event happened | Timestamp |
61+
| `venueId` | Foursquare ID of visit venue | String |
62+
| `venueName` | Name of visit venue | String |
63+
| `visitType` | Visit type | arrival, departure, historical |
64+
| `zipCode` | Zip or postal code for visit venue | String |
65+
66+
Example:
67+
```js
68+
"address": "225 W Ohio St",
69+
"city": "Chicago",
70+
"confidence": "high",
71+
"country": "US",
72+
"crossStreet": "",
73+
"lat": "41.892114",
74+
"lng": "-87.635638",
75+
"locationType": "work",
76+
"primaryCategoryId": "4bf58dd8d48988d130941735",
77+
"primaryCategoryName": "Building",
78+
"probability": "0.5112834298670852",
79+
"state": "IL",
80+
"timestamp": "2020-01-22T15:04:55.000Z",
81+
"venueId": "4d21e2ffdd6a236a9c514338",
82+
"venueName": "225 West Ohio",
83+
"visitId": "5e286497d6d764000801604d",
84+
"visitType": "arrival",
85+
"zipCode": "60654"
86+
```
87+
88+
#### Geofence Event Properties
89+
90+
| Property Name | Description | Values |
91+
| -------------------- | ------------------------------------------------- | --------------------------------------------------------- |
92+
| `categoryIds` | Comma separated string of Foursquare category IDs | String |
93+
| `geofenceEventType` | Geofence event type | `venueEnter`, `venueDwell`, `venueConfirmed`, `venueExit` |
94+
| `geofenceId` | Foursquare Geofence ID | String |
95+
| `geofenceLat` | Latitude of triggered geofence center | Double |
96+
| `geofenceLng` | Longitude of triggered geofence center | Double |
97+
| `geofenceName` | Name of triggered geofence | String |
98+
| `geofenceProperties` | Custom properties of triggered geofence | Key/value Pair |
99+
| `radius` | Minimum 50m, radius of triggered geofence | Int |
100+
| `venueChainIds` | Comma separated string of Foursquare chain IDs | String |
101+
| `venueId` | Foursquare ID of geofenced venue | String |
102+
103+
104+
Example:
105+
```js
106+
"categoryIds": "",
107+
"geofenceEventType": "venueEnter",
108+
"geofenceId": "5dae122e0444bf0008d7f550",
109+
"geofenceLat": "41.89213",
110+
"geofenceLng": "-87.63534",
111+
"geofenceName": "Foursquare Chicago",
112+
"geofenceProperties": {},
113+
"radius": "100.0",
114+
"venueChainIds": "",
115+
"venueId": "52af211911d2aa9d4a1f0e0a"
116+
```
117+
118+
## Adding Destinations
119+
120+
Now that your Source is set up, you can connect it with Destinations.
121+
122+
Log into your downstream tools and check that your events appear and contain all the expected properties. If events and properties do not appear, refer to the Destination docs for troubleshooting.
123+
124+
If you experience any issues with how the events arrive in Segment, [contact the Foursquare team](mailto:[email protected]).

‎src/connections/sources/catalog/cloud-apps/foursquare-pilgrim/index.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

0 commit comments

Comments
 (0)