Foursquare Plugin Configuration

A Foursquare plug-in can be configured to send real-time guest user profile information to a third party application when a guest logs in successfully using the Foursquare plug-in. You can view all the configuration details for the Foursquare plugin. Based on the information, a personalized message or personalized offers can be presented to the guest. You can view it by navigating through Portals-> Click the portal name for which you want to configure Foursquare plugin-> Settings tab-> plugin configuration -> Foursquare icon. Once done with it you need to fill up the details and save it. Once done you will be able to see the configuration settings on the portal specified.

JSON Table

Attribute Data Type Description Default/Sample value
success boolean Specifies whether the API call is successful or not. true
message String A message string indicating whether the API call is successful. Record Found
data application/json A JSON object including the configuration data.
data/totalCount int Total number of data points. 1
data/foursquareConfig application/json
data/foursquareConfig/pid int  Plugin-ID 8
data/foursquareConfig/session_timeout Tenure for whcih session will be active.
data/foursquareConfig/blackout_time Tenure for which user can not login after logging out.
data/foursquareConfig/bandwidth_upload_limit Bandwidth upload limit per user after login.
data/foursquareConfig/bandwidth_download_limit Bandwidth download limit per user after login.
data/foursquareConfig/redirect_landing_url User lands on this url after successful login.
data/foursquareConfig/redirect_endpoint_id User will be redirected to this thirdparty endpoint with data configured after login
data/foursquareConfig/date_created int Date on which foursquare config created. 2017-09-12 10:49:16.618339
data/foursquareConfig/date_modified int Date on which foursquare config modified. 2018-02-07 07:34:41.607583
data/foursquareConfig/redirect_type String redirect_landing_url
data/foursquareConfig/callback_url String This is hardcoded url configured in app https://marketverticalanalytics.airtightnw.com/plugin/instagram/auth

Copy Sample JSON
Sample JSON
    "success": true,
    "message": "Record Found",
    "data": {
        "totalCount": 1,
        "foursquareConfig": {
            "pid": 8,
            "client_id": "",
            "client_secret": "",
            "session_timeout": null,
            "blackout_time": null,
            "bandwidth_upload_limit": null,
            "bandwidth_download_limit": null,
            "redirect_landing_url": null,
            "redirect_endpoint_id": null,
            "date_created": "2017-09-12 10:49:16.618339",
            "date_modified": "2018-02-08 07:08:00.627101",
            "redirect_campaign_id": null,
            "redirect_type": "redirect_landing_url",
            "callback_url": "https://marketverticalanalytics.airtightnw.com/plugin/foursquare/auth",
            "campaign": null
API Calls


Get Foursquare Plugin Configuration

Description Guest Manager users with the Administrator role can access this API.
GET <Base_URL>/portals/{portal_id}/foursquare/config?limit=<value>

  • limit
Sample code
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains configuration details for foursquare plugin.