Survey Tracker

Get a survey tracker by ID

get

Query parameters

idstringRequired

The UUID of the survey tracker to retrieve

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses

200

The survey tracker has been successfully retrieved.

application/json

400

Invalid input format.

401

Unauthorized

404

SurveyTracker not found.

get

/partners/survey-tracker

HTTPcURLJavaScriptPython

GET /partners/survey-tracker?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*

{
  "id": "text",
  "createdAt": "2026-05-14T19:43:17.101Z",
  "updatedAt": "2026-05-14T19:43:17.101Z",
  "surveyId": "text",
  "surveyName": "text",
  "sendAt": "2026-05-14T19:43:17.101Z",
  "sentAt": "2026-05-14T19:43:17.101Z",
  "resendAt": "2026-05-14T19:43:17.101Z",
  "resent": true,
  "sendingIndex": 1,
  "customerId": "text",
  "purchaseId": "text",
  "sendingType": "SMS",
  "status": "SCHEDULED",
  "link": "text",
  "newReviewLink": "text",
  "sentTo": "text",
  "switchedToSms": true,
  "clicks": 1,
  "uniqueClicks": 1
}

List survey trackers

post

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body

application/json

limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10

pagenumber · min: 1Optional

Page to retrieve

Default: 1

fromSendAtstring · nullableOptional

Date range start (sendAt)

toSendAtstring · nullableOptional

Date range end (sendAt)

purchasesstring · uuid[] · min: 1 · max: 100 · nullableOptional

Purchase IDs to filter survey trackers

customersstring · uuid[] · min: 1 · max: 100 · nullableOptional

Customer IDs to filter survey trackers

Responses

201

The survey trackers have been successfully listed.

application/json

400

Invalid input format.

401

Unauthorized

post

/partners/survey-tracker/list

HTTPcURLJavaScriptPython

POST /partners/survey-tracker/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 213

{
  "limit": 10,
  "page": 1,
  "fromSendAt": "text",
  "toSendAt": "text",
  "purchases": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "customers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "statuses": [
    "SCHEDULED"
  ],
  "sendingTypes": [
    "SMS"
  ]
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-05-14T19:43:17.101Z",
      "updatedAt": "2026-05-14T19:43:17.101Z",
      "surveyId": "text",
      "surveyName": "text",
      "sendAt": "2026-05-14T19:43:17.101Z",
      "sentAt": "2026-05-14T19:43:17.101Z",
      "resendAt": "2026-05-14T19:43:17.101Z",
      "resent": true,
      "sendingIndex": 1,
      "customerId": "text",
      "purchaseId": "text",
      "sendingType": "SMS",
      "status": "SCHEDULED",
      "link": "text",
      "newReviewLink": "text",
      "sentTo": "text",
      "switchedToSms": true,
      "clicks": 1,
      "uniqueClicks": 1
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}

Generate survey trackers

post

Generates external survey trackers for all applicable surveys based on the purchase ID provided. Fullwhere does not send external survey trackers. If an external survey tracker already exists for a survey/purchase combination, it will return the existing tracker.

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body

application/json

surveyIdstring · uuid · nullableOptional

Optional survey ID to filter the search for matching surveys. Please note that the survey must be valid for the specific purchase. Otherwise, an error will be returned.

purchaseIdstring · uuidRequired

Purchase identifier to generate the survey link for

Responses

201

The survey trackers have been successfully generated.

application/json

400

Invalid input format.

401

Unauthorized

404

Purchase not found.

post

/partners/survey-tracker/generate

HTTPcURLJavaScriptPython

POST /partners/survey-tracker/generate HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "surveyId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-05-14T19:43:17.101Z",
      "updatedAt": "2026-05-14T19:43:17.101Z",
      "surveyId": "text",
      "surveyName": "text",
      "sendAt": "2026-05-14T19:43:17.101Z",
      "sentAt": "2026-05-14T19:43:17.101Z",
      "resendAt": "2026-05-14T19:43:17.101Z",
      "resent": true,
      "sendingIndex": 1,
      "customerId": "text",
      "purchaseId": "text",
      "sendingType": "SMS",
      "status": "SCHEDULED",
      "link": "text",
      "newReviewLink": "text",
      "sentTo": "text",
      "switchedToSms": true,
      "clicks": 1,
      "uniqueClicks": 1
    }
  ]
}