Beacon API Reference

InQ.Social beacons are invisible widgets that can be placed on a web page to capture a specific activity like time spent on a page or if user has scrolled a page to a point.

Beacon Fields returned by the API

Name Description Type
 Id Id of the Beacon GUID(String)
 Name Beacon name String
TimeOut A number of seconds before the time-based beacon will trigger. Mandatory only for the Time type beacon. integer
WebsiteId Id of website where the beacon will be placed at GUID(String)
 Type Acceptable values:

  • Time
  • View
String
MetaSpec MetaSpec details, see MetaSpec reference for details MetaSpec
TargetUrl Url of the page where this beacon appears on. String
DateCreated Date of the Beacon creation. String
DateInitialized Date when InQ.Social received a successful request from the Beacon on your website. String
DateLastRequest Date when InQ.Social received the last request from the Beacon. String
ClicksCounter Number of clicks received by the Beacon. String

Security

Each API request must be executed with a set of authentication details, set up in your InQ.Social administration area. Read more on InQ.Social API security options.

Endpoints

The InQ.Social API provides the following endpoints:

List of Beacons for a Website

GET: https://api.inq.social/websites/{id}/beacons

Optional parameters: see paged list paging parameters.

Returns a paged list of beacons for the given website id.

 

Get Beacon Details by Id

GET: https://api.inq.social/beacons/{website-id}

Returns the Beacon object.

Create

POST: https://api.inq.social/websites/{website-id}/beacons

Request Fields

Name Mandatory Description Type
 Name Yes Beacon name String
WebsiteId Yes Id of website where the Beacon will be placed at GUID(String)
Type Yes Acceptable values:

  • Time
  • View
String
TimeOut Yes/No A number of seconds before the time-based beacon will trigger. Mandatory only for the Time type beacon. integer
MetaSpec Yes MetaSpec details, see MetaSpec reference for details String
TargetUrl No Url where this beacon will be used at. String

Response: if successful, the API will return status 200 and the new audience Id.

 

Update

PUT: https://api.inq.social/websites/{website-id}/beacons

Request Fields

Name Mandatory Description Type
 Id Yes Id of the Beacon GUID(String)
 Name Yes Beacon name String
TimeOut Yes/No A number of seconds before the time-based beacon will trigger. Mandatory only for the Time type beacon. integer
TargetUrl No Url where this beacon will be used at. String

Response: if successful, the API will return status 200.

 

Delete

DELETE: https://api.inq.social/beacons/{beacon-id}

Response: if successful, the API will return status 200.

 

Check if a customer clicked a Beacon

GET: https://api.inq.social/beacons/{beacon-id}/customer/{customer-id}/isactioned

Mandatory URL parameters:
Beacon-id: the beacon id
Customer-id: the customer’s id

Response: if successful, the API will return status 200 and a boolean value of true/false if the customer has clicked the Beacon or not.

 

Create Whisper Beacon Report