Public API – GET Check-in Activities

The checkinactivities endpoint returns a list of check-in activities as a JSON Array for a customer’s  Application or Zone. Specify both the CustomerApiKey and Application apiKey to get all check-in activities for a given application or also include a specific zoneId of a Zone to get all the check-in activities for that particular Zone.

image

Version 1 of the GET Check-in Activities API is decommissioned.

URL to call

https://api.bluedotinnovation.com/3/checkinactivities

Parameters

Name
Required
Data Type
Description
Format
customerApiKey String API key for customer (rather than the app).
apiKey String A specific application identifier, if the check-ins returned, are to be restricted to a particular application.
zoneId String (Required if zone level check-ins are requested.) A specific zone identifier if the check-ins returned are to be restricted to a particular zone.
pageToken String The token to access the next page of check-in data, each page has 1000 Check-in records.
receivedAtStart String First day for which check-in activities was reported on our Backend.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
receivedAtEnd String Last day for which check-in activities was reported on our Backend.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
checkInTimeStart String First day for which check-in activities triggered on the mobile device.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
checkInTimeEnd String Last day for which check-in activities triggered on the mobile device.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss

Example: Using test keys

First 1000 Check-in records of a particular Application

https://api.bluedotinnovation.com/3/checkinactivities?customerApiKey=7cd1ea81-d40e-11e4-84cb-b8ca3a6b879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d

 

First 1000 Check-in records of a particular Zone in an Application

https://api.bluedotinnovation.com/3/checkinactivities?customerApiKey=7cd1ea81-d40e-11e4-84cb-b8ca3a6b879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&zoneId=ffece0a9-fd21-4148-892e-0a61d01a6bd4

First 100 Check-in records of a particular Application for the date range 2016-08-01 to 2016-09-01 when they were received on our Backend

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea80-d40e-11e4-84cb-b8ca3a6e879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&receivedAtStart=2016-08-01&receivedAtEnd=2016-09-01

Next page of Check-in records for a particular Zone of an Application for the date range 2016-08-01T10:30:00 to 2016-09-01T16:00:30 when the check-ins were triggered on the mobile device

https://api.bluedotinnovation.com/3/checkinactivities?customerApiKey=7cd1ea80-d40e-11e4-84cb-b8ca3a6e879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&zoneId=ffece0a9-fd21-4148-892e-0a61d01a6bd4&checkInTimeStart=2016-08-01T10:30:00&checkInTimeEnd=2016-09-01T16:00:30&pageToken=eyJsdENyZWF0aW9uVGltZSI6IjIwMTgtMDMtMTRUMTA6NDg6MjguODAwWiIsIm5vdGlmaWNhdGlvbi5hcHBsaWNhdGlvbklkIjoiZTE2MTQ1NDUtYTg1NC00YjdlLWJhOTYtNDcwOTcyNWY0YTgxIiwiY3VzdG9tZXJJZC

Fields returned in JSON response

Name
Description
appBuildVersion The app build version of the application using the Point SDK which triggered the check-in. (Available only for check-ins of SDK version 1.8 and above.)
beaconId The unique identifier of the Beacon that triggered the Check-in. Not returned for Geofence check-ins.
beaconName The name of the Beacon that triggered the check-in. Not returned for Geofence check-ins.
checkInId The unique identifier of the check-in record. (Referred to as ‘_id’ in Version 1.)
checkInTime UTC date and time of the check-in was triggered on the mobile device in ISO format. (Referred to as ‘creationTime’ in Version 1.)
checkOutTime UTC date and time of the check-out was triggered on the mobile device in ISO format. Only available for check-out enabled zones.
deviceBearing The bearing value of the device at the time of check-in, reported as degree.
deviceSpeed The travel speed of the device at the time of check-in, reported as meters per second.
deviceType The type of device that triggered the check-in event, reported as either Android or iOS.
dwellTime The number of minutes a device was within a Fence or within the range of a Beacon. Only available for check-out enabled Zones.
fenceId The unique identifier of the Fence that triggered the check-in. Not returned for Beacon check-ins.
fenceName The name of the Geofence that triggered the check-in. Not returned for Beacon check-ins.
installRef The unique app install reference on the device. (Referred to as ‘bluedotId’ in Version 1.)
latitude Latitude component of the coordinate at which the check-in occurred.
longitude Longitude component of the coordinate at which the check-in occurred.
receivedAt UTC date and time of the check-in was received in our database in ISO format.
sdkVersion The Point SDK version number being used in the application which has triggered the check-in. (Available only for check-ins of SDK version 1.6 and above.)
zoneId  The unique identifier of the Zone that triggered the Check-in.
zoneName  The name of the Zone that triggered the Check-in.

Example: JSON response to the request

{  
    "results":[  
        {  
            "checkInId":"73cbdf0c-5523-46ec-bc15-c9ad362b2a85",
            "installRef":"c92f4a32dc35282d4471b42993f809fa",
            "checkInTime":"2016-09-02T00:08:16.000Z",
            "longitude":144.98173087835312,
            "latitude":-37.819805462370944,
            "fenceName":"Melbourne Cricket Ground Gate 1",
            "deviceSpeed":10,
            "fenceId":"80fc36ad-ee72-4450-ad96-b3fadfc26cb4",
            "zoneName":"Melbourne Cricket Ground",
            "zoneId":"ffece0a9-fd21-4148-892e-0a61d01a6bd4",
            "deviceType":"iPhone",
            "sdkVersion":"1.8.0",
            "appBuildVersion":"2.8.0.639",
            "receivedAt":"2016-09-02T00:22:43.816Z"
        },
        {  
            "checkInId":"cf672a02-57aa-442c-b9f7-71ae34b80b21",
            "installRef":"b92f4a32dc35282d4471ba2993e809fa",
            "checkInTime":"2016-09-02T00:08:06.000Z",
            "longitude":144.9817208200693,
            "latitude":-37.819877501281034,
            "fenceName":"Melbourne Cricket Ground Gate 1",
            "deviceSpeed":5,
            "fenceId":"80fc36ad-ee72-4450-ad96-b3fadfc26cb4",
            "zoneName":"Melbourne Cricket Ground",
            "zoneId":"ffece0a9-fd21-4148-892e-0a61d01a6bd4",
            "deviceType":"LGE Nexus 5",
            "sdkVersion":"1.8.0",
            "appBuildVersion":"2.8.0.639",
            "receivedAt":"2016-09-02T00:22:44.128Z"
        },
		.
		.
		.
        {  
            "checkInId":"797c6eb1-dc4a-42dd-9838-e1c5bcf11ecb",
            "installRef":"812f83cfb64f22ea3e4b8229f6502c12",
            "checkInTime":"2016-09-17T07:12:49.999Z",
            "checkOutTime":"27-11-2015 4:42:56",
            "longitude":144.9823497980833,
            "latitude":-37.81928211876631,
            "beaconName":"Beacon at the cash register",
            "deviceSpeed":0,
            "zoneName":"HUGH TRUMBLE CAFE",
            "zoneId":"5d095d95-87f0-4794-bea7-31fce0db44aa",
            "deviceType":"iPhone",
            "beaconId":"24295321-f776-47b2-bf25-9b52e6a99eb4",
            "dwellTime":2,
            "sdkVersion":"1.6.0",
            "receivedAt":"2016-09-17T07:12:38.022Z"
        },
        {  
            "checkInId":"012a5d07-d508-40d0-8d36-969b416907da",
            "installRef":"812f83cfb64f22ea3e4b8229f6502c12",
            "checkInTime":"2016-08-31T03:16:15.000Z",
            "longitude":144.9823497880833,
            "latitude":-37.81928211875631,
            "beaconName":"Beacon at the cash register",
            "deviceSpeed":0,
            "zoneName":"HUGH TRUMBLE CAFE",
            "zoneId":"5d095d95-87f0-4794-bea7-31fce0db44aa",
            "deviceType":"HTC_M9u",
            "beaconId":"24295321-f776-47b2-bf25-9b52e6a99eb4",
            "dwellTime":7,
            "sdkVersion":"1.7.2",
            "checkOutTime":"2016-08-31T03:16:29.000Z",
            "receivedAt":"2016-08-31T07:12:38.022Z"
        }
    ],
 	"nextPageToken": "eyJsdENyZWF0aW9uVGltZSI6IjIwMTgtMDMtMTRUMTA6NDg6MjguODAwWiIsIm5vdGlmaWNhdGlvbi5hcHBsaWNhdGlvbklkIjoiZTE2MTQ1NDUtYTg1NC00YjdlLWJhOTYtNDcwOTcyNWY0YTgxIiwiY3VzdG9tZXJJZCI6ImFkM2Y2MWMyLTJiZWUtNGRhNy1hYzNkLTU2NzUzYTA2ZDhhNiJ9"
}

URL to call

https://api.bluedotinnovation.com/2/checkinactivities

Parameters

Name
Required
Data Type
Description
Format
customerApiKey String API key for customer (rather than the app).
apiKey String A specific application identifier, if the check-ins returned, are to be restricted to a particular application.
zoneId String (Required if Zone level check-ins are requested.) A specific Zone identifier if the check-ins returned are to be restricted to a particular Zone.
pageNumber Number A specific page number for a paginated result set; each page has 1000 Check-in records.
  • 0 – N
receivedAtStart String First day for which a check-in activity was reported on our backend.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
receivedAtEnd String Last day for which a check-in activity were reported on our backend.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
checkInTimeStart String First day for which a check-in activity was triggered on the mobile device.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss
checkInTimeEnd String Last day for which a check-in activity triggered on the mobile device.
  • YYYY-MM-DD
  • YYYY-MM-DDThh:mm:ss

Example: Using test keys

First 100 check-in records of a particular Application

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea81-d40e-11e4-84cb-b8ca3a6b879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d

Third pagination page of check-in records for a particular Application

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea81-d40e-11e4-84cb-b8ca3a6b879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&pageNumber=2

First 100 check-in records of a particular Zone in an Application

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea81-d40e-11e4-84cb-b8ca3a6b879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&zoneId=ffece0a9-fd21-4148-892e-0a61d01a6bd4

First 100 check-in records of a particular Application for the date range 2016-08-01 to 2016-09-01 when they were received on our backend

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea80-d40e-11e4-84cb-b8ca3a6e879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&receivedAtStart=2016-08-01&receivedAtEnd=2016-09-01&pageNumber=0

Fourth pagination page of check-in records for a particular Zone of an Application for for the date range 2016-08-01T10:30:00 to 2016-09-01T16:00:30 when the check-ins were triggered on the mobile device

https://api.bluedotinnovation.com/2/checkinactivities?customerApiKey=7cd1ea80-d40e-11e4-84cb-b8ca3a6e879d&apiKey=afc346a0-de5e-11e4-af33-b8ca3a7b879d&zoneId=ffece0a9-fd21-4148-892e-0a61d01a6bd4&checkInTimeStart=2016-08-01T10:30:00&checkInTimeEnd=2016-09-01T16:00:30&pageNumber=3

Fields returned in JSON response

Name
Description
appBuildVersion The app build version of the application using the Point SDK which triggered the check-in. (Available only for check-ins of SDK version 1.8 and above.)
beaconId The unique identifier of the beacon that triggered the check-in. Not returned for Geofence check-ins.
beaconName The name of the Beacon that triggered the check-in. Not returned for Geofence check-ins.
checkInId The unique identifier of the check-in record. (Referred to as ‘_id’ in Version 1.)
checkInTime UTC date and time of the check-in was triggered on the mobile device in ISO format. (Referred to as ‘creationTime’ in Version 1.)
checkOutTime UTC date and time of the check-out was triggered on the mobile device in ISO format. Only available for check-out enabled zones.
deviceBearing The bearing value of the device at the time of check-in, reported as degree.
deviceSpeed The travel speed of the device at the time of check-in, reported as meters per second.
deviceType The type of device that triggered the check-in event. Reported as either Android or iOS.
dwellTime The number of minutes a device was within a Fence or within the range of Beacon. Only available for check-out enabled Zones.
fenceId The unique identifier of the Fence that triggered the check-in. Not returned for Beacon check-ins.
fenceName The name of the Geofence that triggered the check-in. Not returned for Beacon check-ins.
installRef The unique app install reference on the device. (Referred to as ‘bluedotId’ in Version 1.)
latitude Latitude component of the coordinate at which the check-in occurred.
longitude Longitude component of the coordinate at which the check-in occurred.
receivedAt UTC date and time of the check-in was received in our database in ISO format.
sdkVersion The Point SDK version number being used in the application which has triggered the check-in. (Available only for check-ins of SDK version 1.6 and above.)
zoneId  The unique identifier of the Zone that triggered the check-in.
zoneName  The name of the Zone that triggered the check-in.

Example: JSON response to request

[ 
   { 
      "checkInId":"73cbdf0c-5523-46ec-bc15-c9ad362b2a85",
      "installRef":"c92f4a32dc35282d4471b42993f809fa",
      "checkInTime": "2016-09-02T00:08:16.000Z",
      "longitude":144.98173087835312,
      "latitude":-37.819805462370944,
      "fenceName":"Melbourne Cricket Ground Gate 1",
      "deviceSpeed":10,
      "fenceId":"80fc36ad-ee72-4450-ad96-b3fadfc26cb4",
      "zoneName":"Melbourne Cricket Ground",
      "zoneId":"ffece0a9-fd21-4148-892e-0a61d01a6bd4",
      "deviceType":"iPhone",
      "sdkVersion": "1.8.0",
      "appBuildVersion": "2.8.0.639",
      "receivedAt": "2016-09-02T00:22:43.816Z"
   },
   { 
      "checkInId": "cf672a02-57aa-442c-b9f7-71ae34b80b21",
      "installRef": "b92f4a32dc35282d4471ba2993e809fa",
      "checkInTime": "2016-09-02T00:08:06.000Z"
      "longitude": 144.9817208200693,
      "latitude": -37.819877501281034,
      "fenceName": "Melbourne Cricket Ground Gate 1",
      "deviceSpeed": 5,
      "fenceId": "80fc36ad-ee72-4450-ad96-b3fadfc26cb4",
      "zoneName": "Melbourne Cricket Ground",
      "zoneId": "ffece0a9-fd21-4148-892e-0a61d01a6bd4",
      "deviceType": "LGE Nexus 5",
      "sdkVersion": "1.8.0",
      "appBuildVersion": "2.8.0.639",
      "receivedAt": "2016-09-02T00:22:44.128Z"
   },
   { 
      "checkInId": "797c6eb1-dc4a-42dd-9838-e1c5bcf11ecb",
      "installRef": "812f83cfb64f22ea3e4b8229f6502c12",
      "checkInTime": "2016-09-17T07:12:49.999Z",
      "checkOutTime": "27-11-2015 4:42:56",
      "longitude": 144.9823497980833,
      "latitude": -37.81928211876631,
      "beaconName": "Beacon at the cash register",
      "deviceSpeed": 0,
      "zoneName": "HUGH TRUMBLE CAFE",
      "zoneId": "5d095d95-87f0-4794-bea7-31fce0db44aa",
      "deviceType": "iPhone",
      "beaconId": "24295321-f776-47b2-bf25-9b52e6a99eb4",
      "dwellTime": 2,
      "sdkVersion": "1.6.0",
      "receivedAt": "2016-09-17T07:12:38.022Z"
   },
   { 
      "checkInId": "012a5d07-d508-40d0-8d36-969b416907da",
      "installRef": "812f83cfb64f22ea3e4b8229f6502c12",
      "checkInTime": "2016-08-31T03:16:15.000Z",
      "checkOutTime": "2016-08-31T03:16:29.000Z",
      "longitude": 144.9823497880833,
      "latitude": -37.81928211875631,
      "beaconName": "Beacon at the cash register",
      "deviceSpeed": 0,
      "zoneName": "HUGH TRUMBLE CAFE",
      "zoneId": "5d095d95-87f0-4794-bea7-31fce0db44aa",
      "deviceType": "HTC_M9u",
      "beaconId": "24295321-f776-47b2-bf25-9b52e6a99eb4",
      "dwellTime": 7,
      "sdkVersion": "1.7.2",
      "checkOutTime": "2016-08-31T03:16:29.000Z",
      "receivedAt": "2016-08-31T07:12:38.022Z"
   }
]

Source code examples

Created by Bluedot DevOps on March 3, 2018

Start the discussion