Survey Tracker

Get a survey tracker by ID

get

Paramètres de requête

idstringRequis

The UUID of the survey tracker to retrieve

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Réponses

200

The survey tracker has been successfully retrieved.

application/json

idstringRequis

Unique identifier

createdAtstring · date-timeRequis

Creation timestamp

updatedAtstring · date-timeRequis

Last update timestamp

surveyIdstringRequis

Survey identifier

surveyNamestringRequis

Survey name

sendAtstring · date-timeRequis

Estimate send date

sentAtstring · date-time · nullableRequis

Actual send date when survey was sent

Default: null

resendAtstring · date-time · nullableRequis

Date of resending the survey if it has not been completed within the time specified in the configuration

Default: null

resentbooleanRequis

Determines whether a resend has been performed

sendingIndexnumberRequis

Index of the sending attempt (0 = first send, 1 = first resend, etc.)

customerIdstringRequis

Identifier of the customer associated with the survey tracker

purchaseIdstringRequis

Identifier of the purchase associated with the survey tracker

sendingTypeall ofRequis

Type of survey sending

string · enumOptionnelValeurs possibles:

statusall ofRequis

Status of the survey tracker

string · enumOptionnelValeurs possibles:

linkstring · nullableRequis

Link to access the survey Only available after the survey has been sent

Default: null

newReviewLinkstring · nullableRequis

Link of the external review page, if available (eg. Google Reviews)

Default: null

sentTostring · nullableRequis

Email or phone number the survey was sent to Only available after the survey has been sent

Default: null

switchedToSmsbooleanRequis

Indicates whether the survey was switched to SMS after failed whatsapp attempts

clicksnumberRequis

Number of clicks on the survey link

uniqueClicksnumberRequis

Number of unique clicks on the survey link

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-03-14T20:48:21.253Z",
  "updatedAt": "2026-03-14T20:48:21.253Z",
  "surveyId": "text",
  "surveyName": "text",
  "sendAt": "2026-03-14T20:48:21.253Z",
  "sentAt": "2026-03-14T20:48:21.253Z",
  "resendAt": "2026-03-14T20:48:21.253Z",
  "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

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps

application/json

limitnumber · min: 1 · max: 100Optionnel

Pagination limit

Default: 10

pagenumber · min: 1Optionnel

Page to retrieve

Default: 1

fromSendAtstring · nullableOptionnel

Date range start (sendAt)

toSendAtstring · nullableOptionnel

Date range end (sendAt)

purchasesstring[] · min: 1 · max: 100 · nullableOptionnel

Purchase IDs to filter survey trackers

customersstring[] · min: 1 · max: 100 · nullableOptionnel

Customer IDs to filter survey trackers

Réponses

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: 137

{
  "limit": 10,
  "page": 1,
  "fromSendAt": "text",
  "toSendAt": "text",
  "purchases": [
    "text"
  ],
  "customers": [
    "text"
  ],
  "statuses": [
    []
  ],
  "sendingTypes": [
    []
  ]
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-03-14T20:48:21.253Z",
      "updatedAt": "2026-03-14T20:48:21.253Z",
      "surveyId": "text",
      "surveyName": "text",
      "sendAt": "2026-03-14T20:48:21.253Z",
      "sentAt": "2026-03-14T20:48:21.253Z",
      "resendAt": "2026-03-14T20:48:21.253Z",
      "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.

Paramètres d'en-tête

X-API-KEYstringRequis

Partner API Key

X-API-SECRETstringRequis

Partner API Secret

Corps

application/json

purchaseIdstringRequis

Purchase identifier to generate the survey link for

Réponses

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: 21

{
  "purchaseId": "text"
}

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