Skip to content

Surveys API ​

On-site surveys shown by the tracker. The public `/s/{key}` endpoints are used by the tracker itself (server root, not /api/v1).

All paths are relative to https://your-site.com/api/v1. Send Authorization: Bearer <token> and Accept: application/json; see authentication and errors.

MethodPathWhat it does
GET/sites/{site}/survey-designsThe site's survey designs (default first) and the prepared templates to start from (recordings:read)
POST/sites/{site}/survey-designsA new design from a template (classic, minimal, dark, soft, bold, glass, compact, elegant) with changes; the site's first is its default (recordings:write, at most 30 per site)
PATCH/sites/{site}/survey-designs/{design}Changes a design's name, style or accent, or makes it the site's default (recordings:write)
DELETE/sites/{site}/survey-designs/{design}Deletes a design: its surveys use the default; a deleted default is replaced by the oldest other design (recordings:write)
GET/sites/{site}/surveysThe site's surveys (newest first) with their total responses
POST/sites/{site}/surveysCreates a survey (recordings:write); a draft unless status says otherwise
GET/sites/{site}/surveys/{survey}One survey
PATCH/sites/{site}/surveys/{survey}Changes a survey (recordings:write); only the parts sent
DELETE/sites/{site}/surveys/{survey}Deletes a survey and its answers (recordings:write)
GET/sites/{site}/surveys/{survey}/resultsResults for a period (default the last 30 days)
GET/sites/{site}/surveys/{survey}/responsesThe answers of a period, newest first, 50 per page
GET/sites/{site}/surveys/{survey}/responses/exportThe same answers as a CSV file (every one, newest first)

GET /sites/{site}/survey-designs ​

The site's survey designs (default first) and the prepared templates to start from (recordings:read)

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes

Responses ​

  • 200 — data: the designs; meta.templates: id, name, description, suggested accent and style of each template.
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idinteger
data[].namestring
data[].templatestring
data[].styleobjectHow a survey card looks; the accent colour is each survey's own.
data[].style.backgroundstring
data[].style.textstring
data[].style.mutedstring
data[].style.borderstring
data[].style.radiusintegerMinimum 0. Maximum 28.
data[].style.fontstringOne of: system, rounded, serif, mono.
data[].style.shadowstringOne of: none, soft, strong.
data[].style.widthstringOne of: narrow, normal, wide.
data[].style.buttonsstringOne of: filled, outline, pill.
data[].style.headerboolean
data[].style.glassboolean
data[].accentstring
data[].is_defaultboolean
metaobject
meta.templatesobject[]
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/survey-designs" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

POST /sites/{site}/survey-designs ​

A new design from a template (classic, minimal, dark, soft, bold, glass, compact, elegant) with changes; the site's first is its default (recordings:write, at most 30 per site)

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
namestringyesAt most 80 characters.
templatestringyes
accentstring
is_defaultboolean
styleobjectHow a survey card looks; the accent colour is each survey's own.
style.backgroundstring
style.textstring
style.mutedstring
style.borderstring
style.radiusintegerMinimum 0. Maximum 28.
style.fontstringOne of: system, rounded, serif, mono.
style.shadowstringOne of: none, soft, strong.
style.widthstringOne of: narrow, normal, wide.
style.buttonsstringOne of: filled, outline, pill.
style.headerboolean
style.glassboolean

Responses ​

  • 201 — The design.
  • 422 —
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.namestring
data.templatestring
data.styleobjectHow a survey card looks; the accent colour is each survey's own.
data.style.backgroundstring
data.style.textstring
data.style.mutedstring
data.style.borderstring
data.style.radiusintegerMinimum 0. Maximum 28.
data.style.fontstringOne of: system, rounded, serif, mono.
data.style.shadowstringOne of: none, soft, strong.
data.style.widthstringOne of: narrow, normal, wide.
data.style.buttonsstringOne of: filled, outline, pill.
data.style.headerboolean
data.style.glassboolean
data.accentstring
data.is_defaultboolean
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/survey-designs" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"text","template":"text","accent":"#2563eb","is_default":true,"style":{"background":"#ffffff","text":"text","muted":"text","border":"text","radius":0,"font":"system","shadow":"none","width":"narrow","buttons":"filled","header":true,"glass":true}}'

PATCH /sites/{site}/survey-designs/{design} ​

Changes a design's name, style or accent, or makes it the site's default (recordings:write)

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
designpathintegeryes

Request body ​

application/json

FieldTypeRequiredDescription
namestringAt most 80 characters.
accentstring
is_defaultboolean
styleobjectHow a survey card looks; the accent colour is each survey's own.
style.backgroundstring
style.textstring
style.mutedstring
style.borderstring
style.radiusintegerMinimum 0. Maximum 28.
style.fontstringOne of: system, rounded, serif, mono.
style.shadowstringOne of: none, soft, strong.
style.widthstringOne of: narrow, normal, wide.
style.buttonsstringOne of: filled, outline, pill.
style.headerboolean
style.glassboolean

Responses ​

  • 200 — The design.
  • 404 — Missing, or another account's.
  • 422 —
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.namestring
data.templatestring
data.styleobjectHow a survey card looks; the accent colour is each survey's own.
data.style.backgroundstring
data.style.textstring
data.style.mutedstring
data.style.borderstring
data.style.radiusintegerMinimum 0. Maximum 28.
data.style.fontstringOne of: system, rounded, serif, mono.
data.style.shadowstringOne of: none, soft, strong.
data.style.widthstringOne of: narrow, normal, wide.
data.style.buttonsstringOne of: filled, outline, pill.
data.style.headerboolean
data.style.glassboolean
data.accentstring
data.is_defaultboolean
bash
curl -X PATCH "https://your-site.com/api/v1/sites/{site}/survey-designs/{design}" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"text","accent":"text","is_default":true,"style":{"background":"#ffffff","text":"text","muted":"text","border":"text","radius":0,"font":"system","shadow":"none","width":"narrow","buttons":"filled","header":true,"glass":true}}'

DELETE /sites/{site}/survey-designs/{design} ​

Deletes a design: its surveys use the default; a deleted default is replaced by the oldest other design (recordings:write)

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
designpathintegeryes

Responses ​

  • 204 — Deleted.
  • 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/survey-designs/{design}" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

GET /sites/{site}/surveys ​

The site's surveys (newest first) with their total responses

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes

Responses ​

  • 200 — Surveys.
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idinteger
data[].site_idinteger
data[].namestring
data[].statusstringOne of: draft, active, paused.
data[].questionsobject[]
data[].questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
data[].questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
data[].questions[].textstringyesAt most 300 characters.
data[].questions[].optionsstring[]Choice questions only. At most 8 items.
data[].questions[].requiredbooleanDefault false.
data[].questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
data[].targetingobject
data[].targeting.pageobject
data[].targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
data[].targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
data[].targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
data[].targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
data[].targeting.eventstring, nullableAt most 64 characters.
data[].targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
data[].targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
data[].appearanceobject
data[].appearance.positionstringOne of: right, left, center. Default "right".
data[].appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
data[].appearance.thanksstring, nullableAt most 200 characters.
data[].appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
data[].responsesintegerAll responses (in lists).
data[].created_atstring (date-time), nullable
data[].updated_atstring (date-time), nullable
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/surveys" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

POST /sites/{site}/surveys ​

Creates a survey (recordings:write); a draft unless status says otherwise

403 when the account's plan allows no more surveys (plan feature surveys.count).

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
namestringyesAt most 120 characters.
statusstringOne of: draft, active, paused.
questionsobject[]yesAt most 10 items.
questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
questions[].textstringyesAt most 300 characters.
questions[].optionsstring[]Choice questions only. At most 8 items.
questions[].requiredbooleanDefault false.
questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
questions[].show_if.questionstringThe id of an earlier question.
questions[].show_if.opstringOne of: is, is_not, at_least, at_most.
questions[].show_if.valuestring | integer
targetingobject
targeting.pageobject
targeting.page.opstringOne of: any, is, contains, begins, pattern. Default "any".
targeting.page.valuestring, nullableAt most 500 characters.
targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
targeting.eventstring, nullableAt most 64 characters.
targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
appearanceobject
appearance.positionstringOne of: right, left, center. Default "right".
appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
appearance.thanksstring, nullableAt most 200 characters.
appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
appearance.launcher.enabledbooleanDefault false.
appearance.launcher.iconstringOne of: chat, star, heart, smile, megaphone. Default "chat".
appearance.launcher.labelstring, nullableAt most 40 characters.

Responses ​

  • 201 — Created.
  • 403 — Not allowed (not an administrator, or outside the token's abilities).
  • 404 — Missing, or another account's.
  • 422 — Validation failed.
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.site_idinteger
data.namestring
data.statusstringOne of: draft, active, paused.
data.questionsobject[]
data.questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
data.questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
data.questions[].textstringyesAt most 300 characters.
data.questions[].optionsstring[]Choice questions only. At most 8 items.
data.questions[].requiredbooleanDefault false.
data.questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
data.targetingobject
data.targeting.pageobject
data.targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
data.targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
data.targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
data.targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
data.targeting.eventstring, nullableAt most 64 characters.
data.targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
data.targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
data.appearanceobject
data.appearance.positionstringOne of: right, left, center. Default "right".
data.appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
data.appearance.thanksstring, nullableAt most 200 characters.
data.appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
data.responsesintegerAll responses (in lists).
data.created_atstring (date-time), nullable
data.updated_atstring (date-time), nullable
bash
curl -X POST "https://your-site.com/api/v1/sites/{site}/surveys" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"text","status":"draft","questions":[{"id":"text","type":"nps","text":"text"}],"targeting":{"page":{"op":"any","value":"text"},"device":"all","delay_s":5,"sample":100,"trigger":"delay","event":"text","min_sessions":1,"max_completions":1},"appearance":{"position":"right","color":"text","thanks":"text","launcher":{"enabled":false,"icon":"chat","label":"text"}}}'

GET /sites/{site}/surveys/{survey} ​

One survey

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes

Responses ​

  • 200 — The survey.
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.site_idinteger
data.namestring
data.statusstringOne of: draft, active, paused.
data.questionsobject[]
data.questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
data.questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
data.questions[].textstringyesAt most 300 characters.
data.questions[].optionsstring[]Choice questions only. At most 8 items.
data.questions[].requiredbooleanDefault false.
data.questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
data.targetingobject
data.targeting.pageobject
data.targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
data.targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
data.targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
data.targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
data.targeting.eventstring, nullableAt most 64 characters.
data.targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
data.targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
data.appearanceobject
data.appearance.positionstringOne of: right, left, center. Default "right".
data.appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
data.appearance.thanksstring, nullableAt most 200 characters.
data.appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
data.responsesintegerAll responses (in lists).
data.created_atstring (date-time), nullable
data.updated_atstring (date-time), nullable
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/surveys/{survey}" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

PATCH /sites/{site}/surveys/{survey} ​

Changes a survey (recordings:write); only the parts sent

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes

Request body ​

application/json, required

FieldTypeRequiredDescription
namestringyesAt most 120 characters.
statusstringOne of: draft, active, paused.
questionsobject[]yesAt most 10 items.
questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
questions[].textstringyesAt most 300 characters.
questions[].optionsstring[]Choice questions only. At most 8 items.
questions[].requiredbooleanDefault false.
questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
questions[].show_if.questionstringThe id of an earlier question.
questions[].show_if.opstringOne of: is, is_not, at_least, at_most.
questions[].show_if.valuestring | integer
targetingobject
targeting.pageobject
targeting.page.opstringOne of: any, is, contains, begins, pattern. Default "any".
targeting.page.valuestring, nullableAt most 500 characters.
targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
targeting.eventstring, nullableAt most 64 characters.
targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
appearanceobject
appearance.positionstringOne of: right, left, center. Default "right".
appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
appearance.thanksstring, nullableAt most 200 characters.
appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
appearance.launcher.enabledbooleanDefault false.
appearance.launcher.iconstringOne of: chat, star, heart, smile, megaphone. Default "chat".
appearance.launcher.labelstring, nullableAt most 40 characters.

Responses ​

  • 200 — The survey.
  • 404 — Missing, or another account's.
  • 422 — Validation failed.
Response fields
FieldTypeRequiredDescription
dataobject
data.idinteger
data.site_idinteger
data.namestring
data.statusstringOne of: draft, active, paused.
data.questionsobject[]
data.questions[].idstringyesChosen by the client and kept on edits so answers stay with their question. Pattern ^[a-z0-9]{1,12}$.
data.questions[].typestringyesOne of: nps, rating, emoji, thumbs, text, choice.
data.questions[].textstringyesAt most 300 characters.
data.questions[].optionsstring[]Choice questions only. At most 8 items.
data.questions[].requiredbooleanDefault false.
data.questions[].show_ifobject, nullableShown only when an earlier question's answer meets this; answers to questions the visitor was not shown are dropped. at_least / at_most only for scores (nps, rating, emoji).
data.targetingobject
data.targeting.pageobject
data.targeting.devicestringOne of: all, desktop, tablet, mobile. Default "all".
data.targeting.delay_sintegerMinimum 0. Maximum 600. Default 5.
data.targeting.sampleinteger% of visitors who get the survey. Minimum 1. Maximum 100. Default 100.
data.targeting.triggerstringdelay: after delay_s on the page; event: when the site fires the custom event event (__sr.push(['event', name])). One of: delay, event. Default "delay".
data.targeting.eventstring, nullableAt most 64 characters.
data.targeting.min_sessionsintegerFrom the visitor's n-th session. Minimum 1. Maximum 100. Default 1.
data.targeting.max_completionsintegerHow often one visitor may answer it (again in later sessions). Minimum 1. Maximum 100. Default 1.
data.appearanceobject
data.appearance.positionstringOne of: right, left, center. Default "right".
data.appearance.colorstringPattern ^#[0-9a-fA-F]{6}$.
data.appearance.thanksstring, nullableAt most 200 characters.
data.appearance.launcherobjectA tab with an icon and a label that opens the survey, instead of opening by itself.
data.responsesintegerAll responses (in lists).
data.created_atstring (date-time), nullable
data.updated_atstring (date-time), nullable
bash
curl -X PATCH "https://your-site.com/api/v1/sites/{site}/surveys/{survey}" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"text","status":"draft","questions":[{"id":"text","type":"nps","text":"text"}],"targeting":{"page":{"op":"any","value":"text"},"device":"all","delay_s":5,"sample":100,"trigger":"delay","event":"text","min_sessions":1,"max_completions":1},"appearance":{"position":"right","color":"text","thanks":"text","launcher":{"enabled":false,"icon":"chat","label":"text"}}}'

DELETE /sites/{site}/surveys/{survey} ​

Deletes a survey and its answers (recordings:write)

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes

Responses ​

  • 204 — Deleted.
  • 404 — Missing, or another account's.
bash
curl -X DELETE "https://your-site.com/api/v1/sites/{site}/surveys/{survey}" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

GET /sites/{site}/surveys/{survey}/results ​

Results for a period (default the last 30 days)

Per question answered, plus by type — nps: score (% promoters 9–10 minus % detractors 0–6, null without answers), promoters, passives, detractors, distribution (11 counts, 0–10); rating / emoji: average, distribution (5 counts, 1–5); thumbs: up, down; choice: options [{option, votes}]; text: only the count (list the answers with …/responses?question=).

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes
fromquerystring (date)
toquerystring (date)

Responses ​

  • 200 — The results.
  • 404 — Missing, or another account's.
  • 422 — Validation failed.
Response fields
FieldTypeRequiredDescription
dataobject
data.periodobject
data.period.fromstring (date)
data.period.tostring (date)
data.responsesinteger
data.questionsobject[]
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/surveys/{survey}/results" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

GET /sites/{site}/surveys/{survey}/responses ​

The answers of a period, newest first, 50 per page

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes
fromquerystring (date)
toquerystring (date)
questionquerystringOnly responses that answered this question.
npsquerystringWith question (an NPS question): only promoters (9–10), passives (7–8) or detractors (0–6). One of: promoters, passives, detractors.
qquerystringOnly responses whose answers contain this text (any case). At most 200 characters.
pagequeryintegerMinimum 1.

Responses ​

  • 200 — Answers (replay at GET /sites/{site}/sessions/{session}).
  • 404 — Missing, or another account's.
Response fields
FieldTypeRequiredDescription
dataobject[]
data[].idinteger
data[].sessionstring (uuid)
data[].urlstring, nullable
data[].answersobject
data[].created_atstring (date-time)
metaobject
meta.pageinteger
meta.moreboolean
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/surveys/{survey}/responses" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

GET /sites/{site}/surveys/{survey}/responses/export ​

The same answers as a CSV file (every one, newest first)

Columns: time, page, session, then one per question (its text). Answers starting with = + - @ are prefixed with an apostrophe so spreadsheets never run them as formulas.

Parameters ​

NameInTypeRequiredDescription
sitepathintegeryes
surveypathintegeryes
fromquerystring (date)
toquerystring (date)
questionquerystring
npsquerystringOne of: promoters, passives, detractors.
qquerystringAt most 200 characters.

Responses ​

  • 200 — The CSV file.
  • 404 — Missing, or another account's.
bash
curl -X GET "https://your-site.com/api/v1/sites/{site}/surveys/{survey}/responses/export" \
  -H "Authorization: Bearer $REPLORA_TOKEN" \
  -H "Accept: application/json"

Replora: see what your visitors see.