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 (string, required): The number of results to return, up to 250; defaults to 20.
• offset (string, required): The offset of the item at which to begin the response for pagination; defaults to 0 with no max.

Response 200

Success response containing retrieved check-in data for the authenticated user.

Metadata

• meta (object): Metadata object containing additional information about the response.
  • code (integer): Defaults to 0. Status code for successful response from the 'checkins.get' endpoint for the current user.
  • requestId (string): The unique identifier for the API request.

Notifications

• notifications (array of objects): Array of notification objects containing information about the user's check-ins.
  • notification (object): Response object containing an array of notification objects for the authenticated user's check-ins.
    • type (string): Array of notification types for the user's check-ins response.

Response Object

• response (object): Response object containing the retrieved data for check-ins made by the user.
  • checkins (object): An array of check-in objects containing information about the user's past check-ins.

Check-in Structure

The structure of check-in objects within the response:

• id (string)
• createdAt (integer)
• type (string)
• private (boolean)
• visibility (string)
• entities (array)
• shout (string)
• timeZoneOffset (integer)
• venue (object): Venue information.
  • id (string)
  • name (string)
• likes (object): Information about likes.
  • count (integer)
  • groups (array)
• like (boolean)
• isMayor (boolean)
• photos (object): Photo information.
  • count (integer)
  • items (array): Array of photo objects.
• posts (object): Information about posts.
  • count (integer)
  • textCount (integer)
• comments (object): Information about comments.
  • count (integer)
• source (object): Source of the check-in.
  • name (string)
  • url (string)

Example Check-in Object

{
  "id": "59b97e6cf79faa0d5e23abeb",
  "createdAt": 1505328748,
  "type": "checkin",
  "private": true,
  "visibility": "private",
  "entities": [],
  "shout": "Monday monday!",
  "timeZoneOffset": -240,
  "venue": {
    "id": "4f0de7267bebfc146005dcc0",
    "name": "Mattlantis 🐳"
  },
  "likes": {
    "count": 0,
    "groups": []
  },
  "like": false,
  "isMayor": false,
  "photos": {
    "count": 1,
    "items": [
      {
        "id": "59b97e6d270ee77dbf2b8aa0",
        "createdAt": 1505328749,
        "source": {
          "name": "Swarm for iOS",
          "url": "https://www.swarmapp.com"
        },
        "prefix": "https://fastly.4sqi.net/img/general/",
        "suffix": "/7294631_KK8FbnS6sqgrlXgZeCwkYbSn2efiAQBoT7x4p_hteis.jpg",
        "width": 1440,
        "height": 1920,
        "user": {
          "id": "123456",
          "firstName": "John",
          "lastName": "Smith",
          "handle": "johnsmith",
          "privateProfile": false,
          "gender": "male",
          "countryCode": "US",
          "relationship": "self",
          "photo": {
            "prefix": "https://fastly.4sqi.net/img/user/",
            "suffix": "/blank_boy.png",
            "default": true
          },
          "birthday": 19700101,
          "isAnonymous": false
        },
        "visibility": "private"
      }
    ],
    "layout": {
      "name": "single"
    }
  },
  "posts": {
    "count": 0,
    "textCount": 0
  },
  "comments": {
    "count": 0
  },
  "source": {
    "name": "Swarm for iOS",
    "url": "https://www.swarmapp.com"
  }
}