Kontrollera deltagare

Läs en samling deltagare

Endpoint: GET surveys/{surveyId}/participants

Denna endpoint ger dig en samling av dina deltagare i en specifik undersökning. Se definitionen av datatyp nedan.

Läs en enskild deltagare

Endpoint: GET surveys/{surveyId}/participants/{participantId}

Denna slutpunkt kommer att ge dig en enda undersökningsdeltagare.

Data-typ

{
  "id": "616ead85cb4d4a94d79632fd",
  "surveyId": "61682cbd6e5d9861ed52e697",
  "delivered": "2021-10-19T11:35:33.644Z",
  "opened": "2021-10-19T11:35:33.644Z",
  "answered": null,
  "token": "83198df6-13e4-4252-af14-60a458ac09ce",
  "link": "https://ip1-survey-presentation-dev.azurewebsites.net/participant/83198df6-13e4-4252-af14-60a458ac09ce",
  "shortLink": "https://url.ip1.net/iuWDYS",
  "phoneNumber": "46700000000",
  "emailAddress": "link@ip1.se",
  "properties": {
    "source": "byLink",
    "cool": "no"
  }
}

id

Deltagar-ID, används för att referera till det.

surveyId

Undersöknings-ID för undersökningen som deltagaren tillhör.

delivered

En tidsstämpel för när undersökningen levererades till deltagaren.

opened

En tidsstämpel för när deltagaren öppnade undersökningen, om de har.

answered

En tidsstämpel för när deltagaren lämnade in sina svar, om de har.

token

Genererade unika token för deltagaren. Är null om deltagaren skapades från en enkätlänk.

Hela länken för deltagaren att svara på enkäten på. Är null om deltagaren skapades från en enkätlänk.

En kortare länk som omdirigerar till hela länken. Är null om deltagaren skapades från en enkätlänk.

phoneNumber

Telefonnumret som ska användas vid sändning på sms-kanalen.

emailAddress

E-postadressen som ska användas när du skickar på e-postkanalen.

properties

En dictionary över ytterligare egenskaper som kan användas när du mallar meddelanden. Kan även användas för att kategorisera deltagare och mallfrågor.