v1

latestOpenAPI 3.0.02026-07-24283460.8 KB

Surveys

Retrieve Survey Responses

get/widget/survey-responses

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring required

Your REVIEWS.io private api key

campaign_idinteger required

The ID of your survey

Response

idinteger required

Comment ID

user_idinteger required

User ID

completion_timeinteger required

Completion time

hrefstring required

Href

browserstring required

Browser

ip_addressstring required

IP address

date_createdstring date-time required

Date created

date_updatedstring date-time required

Date updated

country_codestring

Country code

total_pricestring required

Total price

order_countinteger required

Order count

tagsstring required

Example response

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
  "ip_address": "127.0.0.1",
  "date_created": "2023-02-13 12:41:08",
  "date_updated": "2023-02-13 12:41:32",
  "total_price": "0.000",
  "tags": "[{'label': 'name', 'value': 'tom'}, {'label': 'email', 'value': 'tom@example.com'}, {'label': 'order_id', 'value': '0123456'}, {'label': 'order_name', 'value': '#1001'}]",
  "responses": [
    {
      "id": 1415,
      "store_widget_survey_submission_id": 4,
      "survey_question_id": 270,
      "response": "Facebook"
    }
  ]
}