Public Beta Feature

This documentation covers a feature currently in Public Beta. Access is available to anyone interested in building personalized experiences for their end-users.

This feature is subject to the Personalization API (Self-Service) Public Beta End user License Agreement.

API Parameters

• version
  string
  required
  The API version date as documented here; e.g. 20231010

• limit
  int32
  The number of results to return, up to 500; defaults to 30.

• offset
  int32
  The offset of the item at which to begin the response for pagination; no max or default.

• categoryId
  string
  The ID of the category of interest (e.g. "Arts and Entertainment"); filter tips for just venues in this category.

• venueId
  string
  The ID of the venue of interest; filter venue tips for only this venue.

Response Codes

200

A user's tips.

• meta
  object
  Metadata object containing additional information about the successful response from the 'GET tips' endpoint for the current user.

  • code
    integer
    Defaults to 0
  • requestId
    string
    A unique identifier for the request.

• notifications
  array of objects
  Array of objects containing information about user notifications for the tips endpoint.

  • item
    object
    Array of notification objects containing the type and number of unread items for a user's tips.
    • type
      string

• response
  object
  Response object containing a user's tips.

  • tips
    object
    Get a list of tips submitted by the authenticated user.

Example Response

{
  "meta": {
    "code": 200,
    "requestId": "6524655bf5e66e4def905286"
  },
  "notifications": [
    {
      "type": "notificationTray",
      "item": {
        "unreadCount": 0
      }
    },
    {
      "type": "unconfirmed",
      "item": {
        "unreadCount": 0
      }
    }
  ],
  "response": {
    "tips": {
      "count": 19,
      "items": [
        {
          "id": "6515f99d8f151130670423d4",
          "createdAt": 1695938973,
          "text": "here is puppy number 2",
          "type": "user",
          "canonicalUrl": "https://foursquare.com/item/6515f99d8f151130670423d4",
          "photo": {
            "id": "6515f99e2425d010750f76fd",
            "createdAt": 1695938974,
            "source": {
              "name": "Foursquare Web",
              "url": "https://foursquare.com"
            },
            "prefix": "https://fastly.4sqi.net/img/general/",
            "suffix": "/1234567_VJqOKo4P9-W0VyQk0iOZZzqG178RAL1rswe4KpZ2YGg.png",
            "width": 480,
            "height": 650,
            "visibility": "public"
          },
          "photourl": "https://fastly.4sqi.net/img/general/original/1234567_VJqOKo4P9-W0VyQk0iOZZzqG178RAL1rswe4KpZ2YGg.png",
          "likes": {
            "count": 0,
            "groups": []
          },
          "like": false,
          "viewCount": 0,
          "agreeCount": 0,
          "disagreeCount": 0,
          "todo": {
            "count": 0
          },
          "venue": {
            "id": "4f0de7267bebfc146005dcc0",
            "name": "Mattlantis 🐳"
          }
        },
        {
          "id": "6515f98d5a5bd638fc6585e6",
          "createdAt": 1695938957,
          "text": "here is puppy number 1",
          "type": "user",
          "canonicalUrl": "https://foursquare.com/item/6515f98d5a5bd638fc6585e6",
          "photo": {
            "id": "6515f98e2425d010750f727a",
            "createdAt": 1695938958,
            "source": {
              "name": "Foursquare Web",
              "url": "https://foursquare.com"
            },
            "prefix": "https://fastly.4sqi.net/img/general/",
            "suffix": "/1234567__mJ46zH779YHTAjC2zLVLR-9UexkcHlhnJ7Bm_vd5Ws.gif",
            "width": 220,
            "height": 220,
            "visibility": "public"
          },
          "photourl": "https://fastly.4sqi.net/img/general/original/1234567__mJ46zH779YHTAjC2zLVLR-9UexkcHlhnJ7Bm_vd5Ws.gif",
          "likes": {
            "count": 0,
            "groups": []
          },
          "like": false,
          "viewCount": 0,
          "agreeCount": 0,
          "disagreeCount": 0,
          "todo": {
            "count": 0
          },
          "venue": {
            "id": "4f0de7267bebfc146005dcc0",
            "name": "Mattlantis 🐳"
          }
        }
      ]
    }
  }
}