Query API Reference

InQ.Social queries are questions, offers and rating request messages with a set of clickable options to provide feedback.

Query Fields returned by the API

Name Description Type
Id Id of the Query GUID(String)
CampaignId Campaign Id GUID(String)
WebsiteId Website Id GUID(String)
 Text Query message String
 Type Acceptable values:

  • YesNo
  • Offer
  • Rating
String
Impressions Number of query impressions. integer
Clicks Number of clicks received by the query. integer
Date Date of the query creation. 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:

Get List of Queries in Organization

GET: https://api.inq.social/organizations/{organization-id}/queries

Optional parameters: see paged list paging parameters.
Returns a paged list of queries for the given organization id.

 

Сreate

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

Request Fields

Name Mandatory Description Type
CampaignId Yes Campaign Id GUID(String)
 Text Yes Query message String
 Type Yes Acceptable values:

  • YesNo
  • Offer
  • Rating
String
Options Yes Array of option objects. Must contain at least one option. Array of option objects.

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

 

Update

PUT: https://api.inq.social/queries/{query-id}

Request Fields

Name Mandatory Description Type
Id Yes Query Id GUID(String)
 Text No Query message String
 Type No Acceptable values:

  • YesNo
  • Offer
  • Rating
String

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

 

Delete

DELETE: https://api.inq.social/queries/{query-id}

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

 

Check if a customer clicked an option in a query

GET: https://api.inq.social/queries/{query-id}/customer/{customerId}/isresponded

Mandatory URL parameters:
Query-id: the query id
Customer-id: the customer’s id

Response: if successful, the API will return status 200 and if the customer clicked an option it will also return the following object. If the customer did not click an option, the return value will be null.