API-Referenz

Eigene Systeme anbinden?

Für Integrationen gibt es die versionierte öffentliche API v1 mit API-Schlüsseln, Scopes und Stabilitätsversprechen (Referenz v1). Die folgende Liste beschreibt die interne API des Dashboards, die sich mit dem Dashboard ändern kann.

Die Endpunkte werden beim Bauen der Doku aus der OpenAPI-Spezifikation erzeugt (frontend/packages/api-client/openapi.json, Version 0.1.0). Die interaktive Dokumentation liefert die API selbst unter /api/docs.

Bereich	Methode	Pfad	Beschreibung
AccountDeletion	GET	/api/me/account-deletion	What deleting the own account would do
AccountDeletion	POST	/api/me/account-deletion	Delete the own account immediately
AccountDeletion	POST	/api/me/data-export	Download the data of the own account (profile, linked accounts, memberships, sessions, own audit log entries)
AiSettings	GET	/api/organizations/{id}/ai-settings	Get the AI settings, budget and usage of the organization (requires organization.view)
AiSettings	PATCH	/api/organizations/{id}/ai-settings	Enable or disable the AI functions of the organization (requires organization.update, admin+)
AiSurveySettings	POST	/api/surveys/{id}/ai-settings	Enable or disable the AI functions for one survey (requires surveys.edit)
AiTextAnalysis	GET	/api/ai-analyses/{id}	Get an AI analysis with status, progress, cost and the topic report (requires analytics.view)
AiTextAnalysis	POST	/api/surveys/{id}/analytics/text-ai	Start the AI analysis of a free-text question (requires analytics.ai and the organization's opt-in)
AiTextEstimate	POST	/api/surveys/{id}/analytics/text-ai/estimate	Estimate the AI analysis of a free-text question: availability, answers, cost and budget (requires analytics.view)
AlertRule	GET	/api/alert-rules	List the alert rules (requires analytics.view)
AlertRule	POST	/api/alert-rules	Create an alert rule (requires reports.manage)
AlertRule	GET	/api/alert-rules/{id}	Get an alert rule with its state (requires analytics.view)
AlertRule	PATCH	/api/alert-rules/{id}	Change, pause or resume an alert rule (requires reports.manage)
AlertRule	DELETE	/api/alert-rules/{id}	Delete an alert rule and its delivery log (requires reports.manage). Audit-logged (`alert_rule.deleted`).
AnalyticsBehaviour	POST	/api/surveys/{id}/analytics/behaviour	Time per question, speeders and channel/embed comparison (requires analytics.view)
AnalyticsCompare	POST	/api/surveys/{id}/analytics/compare	Compare two segments, versions or time ranges (requires analytics.view)
AnalyticsCrosstab	POST	/api/surveys/{id}/analytics/crosstab	Crosstab of two variables with chi-square test (requires analytics.view)
AnalyticsCrosstab	POST	/api/surveys/{id}/analytics/crosstab/export	Download a crosstab as CSV or XLSX (requires analytics.export)
AnalyticsDimensions	POST	/api/surveys/{id}/analytics/dimensions	Filter suggestions: distinct dimension values with counts (requires analytics.view)
AnalyticsFunnel	POST	/api/surveys/{id}/analytics/funnel	Funnel impression → start → answered per question → completion (requires analytics.view)
AnalyticsOverview	POST	/api/surveys/{id}/analytics/overview	KPIs of the survey (requires analytics.view)
AnalyticsQuestions	POST	/api/surveys/{id}/analytics/questions	Results per question of the current version (requires analytics.view)
AnalyticsTextAnswers	POST	/api/surveys/{id}/analytics/text-answers	Search and list the free-text answers of a question (requires analytics.view)
AnalyticsTextKeywords	POST	/api/surveys/{id}/analytics/text-keywords	Most frequent words of the free-text answers of a question (requires analytics.view)
AnalyticsTimeseries	POST	/api/surveys/{id}/analytics/timeseries	Starts and completions per hour, day or week (requires analytics.view)
ApiKey	GET	/api/api-keys	List the API keys of the active organization (requires api_keys.manage)
ApiKey	POST	/api/api-keys	Create an API key (requires api_keys.manage)
ApiKey	GET	/api/api-keys/{id}	Get an API key (requires api_keys.manage)
ApiKey	POST	/api/api-keys/{id}/revoke	Revoke an API key (requires api_keys.manage)
AuditLogEntry	GET	/api/organizations/{id}/audit-log	List the audit log of the active organization, newest first (requires audit.view)
Auth	GET	/api/auth/captcha	Get a proof-of-work captcha challenge
Auth	POST	/api/auth/login	Log in with e-mail and password
Auth	POST	/api/auth/login/two-factor	Complete a login with a TOTP or backup code
Auth	POST	/api/auth/logout	Sign out the session of the refresh token cookie
Auth	GET	/api/auth/oauth/{provider}/callback	Redirect URI of the providers
Auth	GET	/api/auth/oauth/{provider}/start	Start an OAuth sign-in (browser navigation)
Auth	POST	/api/auth/oauth/exchange	Exchange the single-use code of the OAuth callback
Auth	POST	/api/auth/refresh	Exchange the refresh token cookie for a new access token
BillingInvoiceList	GET	/api/organizations/{id}/billing/invoices	The newest invoices of the organization (requires billing.manage)
Collect	GET	/api/collect/captcha	Get a captcha challenge for surveys with settings.captcha
Collect	POST	/api/collect/events	Record funnel events (also as text/plain for navigator.sendBeacon)
Collect	GET	/api/collect/responses/{responseId}	Get the saved state of a response to continue it (resume after a reload)
Collect	PATCH	/api/collect/responses/{responseId}	Save answers of a multi-page survey partially
Collect	POST	/api/collect/responses/{responseId}/complete	Complete a response
Collect	GET	/api/collect/surveys/{publicId}	Get the published survey for respondents
Collect	GET	/api/collect/surveys/{publicId}/results	Get the results if the survey's results visibility allows it
Collect	POST	/api/collect/surveys/{publicId}/sessions	Start a response session
CreditHistory	GET	/api/organizations/{id}/billing/credits	Credit bookings of the organization, newest first (requires billing.manage)
CustomDomain	GET	/api/custom-domains	List the custom domains of the active organization (requires organization.view)
CustomDomain	POST	/api/custom-domains	Add a custom domain (requires domains.manage)
CustomDomain	GET	/api/custom-domains/{id}	Get a custom domain (requires organization.view)
CustomDomain	DELETE	/api/custom-domains/{id}	Remove a custom domain (requires domains.manage)
CustomDomain	POST	/api/custom-domains/{id}/verify	Check the DNS records of a custom domain now (requires domains.manage)
DataExport	GET	/api/exports/{id}	Get an export with its status and download link (requires analytics.export)
DataExport	GET	/api/surveys/{id}/exports	List the latest 50 exports of a survey, newest first (requires analytics.export)
DataExport	POST	/api/surveys/{id}/exports	Export the responses as CSV, XLSX or SPSS, or the analytics report as PDF (requires analytics.export)
EmailChangeConfirmation	POST	/api/auth/email/confirm	Confirm a new e-mail address with the token from the confirmation e-mail
EmailChangeRequest	POST	/api/me/email	Request a change of the e-mail address
EmailVerification	POST	/api/auth/verify-email	Confirm an e-mail address with the token from the verification e-mail
EmbedConfig	GET	/api/embeds/{id}	Get an embed configuration (requires surveys.view)
EmbedConfig	PATCH	/api/embeds/{id}	Change an embed configuration (requires surveys.edit)
EmbedConfig	DELETE	/api/embeds/{id}	Delete an embed configuration (requires surveys.edit)
EmbedConfig	GET	/api/surveys/{id}/embeds	List the embed configurations of a survey, oldest first (requires surveys.view)
EmbedConfig	POST	/api/surveys/{id}/embeds	Create an embed configuration (requires surveys.edit)
EmbedSecret	GET	/api/organizations/{id}/embed-secret	Get the secret for signed identity tokens (requires api_keys.manage, admin+)
EmbedSecret	POST	/api/organizations/{id}/embed-secret/rotate	Replace the secret for signed identity tokens (requires api_keys.manage, admin+)
Health	GET	/health	Liveness and readiness probe
Invitation	GET	/api/organizations/{id}/invitations	List the open invitations of the organization (requires members.manage)
Invitation	POST	/api/organizations/{id}/invitations	Invite someone by e-mail (requires members.manage; only owners may invite owners)
Invitation	DELETE	/api/organizations/{id}/invitations/{invitationId}	Revoke an invitation (requires members.manage)
Invitation	POST	/api/organizations/{id}/invitations/{invitationId}/resend	Send an invitation again (requires members.manage)
InvitationAcceptance	POST	/api/invitations/accept	Accept an invitation and join the organization
InvitationPreview	GET	/api/invitations/preview	Show the invitation of a token from an invitation e-mail (public)
LinkedIdentity	GET	/api/me/identities	List the provider accounts linked to the current user
LinkedIdentity	DELETE	/api/me/identities/{id}	Unlink a provider account
LinkedIdentity	POST	/api/me/identities/link	Start linking a provider account
Me	GET	/api/me	Profile of the authenticated user
Me	PATCH	/api/me	Update name, language or time zone of the authenticated user
Member	GET	/api/organizations/{id}/members	List the members of the organization (requires members.view)
Member	PATCH	/api/organizations/{id}/members/{membershipId}	Change the role of a member (requires members.manage)
Member	DELETE	/api/organizations/{id}/members/{membershipId}	Remove a member, or leave the organization (own membership)
MyActivity	GET	/api/me/activity	List the last 50 security events of the current user, newest first
MyPermissions	GET	/api/me/permissions	Role and permissions of the current user in the active organization
NotificationDelivery	POST	/api/alert-rules/{id}/test	Send a test alert with the current values (requires reports.manage)
NotificationDelivery	GET	/api/notification-deliveries	The delivery log of reports and alerts, newest first (requires analytics.view)
NotificationDelivery	GET	/api/notification-deliveries/{id}	Get one delivery of the log, e.g. to follow a "send now" (requires analytics.view)
NotificationDelivery	POST	/api/report-schedules/{id}/send	Send a scheduled report now (requires reports.manage)
OAuthLinkConfirmation	POST	/api/auth/oauth/confirm-link	Link a provider account with the token from the confirmation e-mail
OAuthProvider	GET	/api/auth/oauth/providers	List the enabled OAuth sign-in providers
Organization	GET	/api/organizations	List the organizations of the current user
Organization	POST	/api/organizations	Create an organization owned by the current user (free plan)
Organization	GET	/api/organizations/{id}	Get an organization of the current user
Organization	PATCH	/api/organizations/{id}	Rename an organization or change its slug (requires organization.update)
OrganizationAnalytics	POST	/api/analytics/organization	Analytics across the surveys of the organization (requires analytics.view)
OrganizationBilling	GET	/api/organizations/{id}/billing	Credit balance and the credit packs on sale (requires billing.manage)
OrganizationBilling	POST	/api/organizations/{id}/billing/checkout	Start a Stripe Checkout for a credit pack (requires billing.manage)
OrganizationBilling	POST	/api/organizations/{id}/billing/portal	Open the Stripe Customer Portal (requires billing.manage)
OrganizationBranding	GET	/api/organizations/{id}/branding	Get the branding of the organization (requires organization.view)
OrganizationBranding	PUT	/api/organizations/{id}/branding	Change the branding (requires organization.update)
OrganizationBranding	PUT	/api/organizations/{id}/branding/logo	Set or remove the logo (requires organization.update)
OrganizationBranding	POST	/api/organizations/{id}/branding/sender-domain/verify	Check the DNS TXT record of the sender domain (requires organization.update)
OrganizationUsage	GET	/api/organizations/{id}/usage	Plan, usage and features of the organization
OwnershipTransfer	POST	/api/organizations/{id}/transfer-ownership	Hand the ownership over to another member (owners only)
PasswordChange	POST	/api/me/password	Change the password of the authenticated user
PasswordForgot	POST	/api/auth/password/forgot	Request a password reset link by e-mail
PasswordReset	POST	/api/auth/password/reset	Set a new password with the token from the reset e-mail
PrivacyRequest	GET	/api/privacy-requests	List the data subject requests of the organization, newest first (requires privacy.manage)
PrivacyRequest	POST	/api/privacy-requests	Start a data subject request: search the responses of one person (requires privacy.manage)
PrivacyRequest	GET	/api/privacy-requests/{id}	Get a data subject request (requires privacy.manage)
PrivacyRequest	POST	/api/privacy-requests/{id}/complete	Mark the data subject request as completed, e.g. after an access request (requires privacy.manage)
PrivacyRequest	POST	/api/privacy-requests/{id}/erase	Delete the responses of the request's subject (requires privacy.manage)
PrivacyRequest	POST	/api/privacy-requests/{id}/export	Download the export for the data subject (requires privacy.manage)
PrivacyRequest	POST	/api/privacy-requests/{id}/search	Search the responses of the request's subject again (requires privacy.manage)
PrivacySettings	GET	/api/organizations/{id}/privacy-settings	Get the retention settings of the organization (requires organization.view)
PrivacySettings	PATCH	/api/organizations/{id}/privacy-settings	Set the default retention period of responses (requires privacy.manage, admin+)
Project	GET	/api/projects	List the projects of the active organization in position order (requires surveys.view)
Project	POST	/api/projects	Create a project at the end of the list (requires surveys.edit)
Project	GET	/api/projects/{id}	Get a project (requires surveys.view)
Project	PATCH	/api/projects/{id}	Rename or move a project (requires surveys.edit)
Project	DELETE	/api/projects/{id}	Delete a project; its surveys are kept without project (requires surveys.edit)
Public API v1: Analytics	GET	/api/v1/surveys/{id}/analytics	Key figures and results per question (scope analytics:read)
Public API v1: Responses	GET	/api/v1/responses/{id}	Get a response with all answers (scope responses:read)
Public API v1: Responses	DELETE	/api/v1/responses/{id}	Delete a response permanently (scope responses:write)
Public API v1: Responses	GET	/api/v1/surveys/{surveyId}/responses	List the responses of a survey (scope responses:read)
Public API v1: Surveys	GET	/api/v1/surveys	List surveys (scope surveys:read)
Public API v1: Surveys	POST	/api/v1/surveys	Create a draft (scope surveys:write)
Public API v1: Surveys	GET	/api/v1/surveys/{id}	Get a survey with its structure (scope surveys:read)
Public API v1: Surveys	PATCH	/api/v1/surveys/{id}	Change title or description (scope surveys:write)
Public API v1: Surveys	POST	/api/v1/surveys/{id}/close	Close a live or scheduled survey (scope surveys:write; 409 from other statuses)
Public API v1: Surveys	POST	/api/v1/surveys/{id}/publish	Publish the draft as a new version (scope surveys:write)
RealtimeToken	GET	/api/surveys/{id}/realtime-token	Get a Mercure subscriber token for the survey's private topic (requires surveys.view)
Registration	POST	/api/auth/register	Create an account and its organization
ReportSchedule	GET	/api/report-schedules	List the scheduled reports (requires analytics.view)
ReportSchedule	POST	/api/report-schedules	Schedule an e-mail report (requires reports.manage)
ReportSchedule	GET	/api/report-schedules/{id}	Get a scheduled report (requires analytics.view)
ReportSchedule	PATCH	/api/report-schedules/{id}	Change, pause or resume a scheduled report (requires reports.manage)
ReportSchedule	DELETE	/api/report-schedules/{id}	Delete a scheduled report and its delivery log (requires reports.manage). Audit-logged (`report_schedule.deleted`).
Response	GET	/api/responses/{id}	Get a response with all answers, context and flag history (requires analytics.view)
Response	DELETE	/api/responses/{id}	Delete a response and its answers permanently (requires responses.manage)
Response	POST	/api/responses/{id}/exclude	Exclude a response from the statistics (requires responses.manage)
Response	POST	/api/responses/{id}/flag	Flag a response (requires responses.manage)
Response	POST	/api/responses/{id}/include	Include an excluded or flagged response again (requires responses.manage)
Response	POST	/api/responses/{id}/unflag	Remove the flag of a response, automatic or manual (requires responses.manage)
ResponseBulkAction	POST	/api/surveys/{id}/responses/bulk	Flag, unflag, exclude, include or delete selected responses (requires responses.manage)
ResponseColumns	GET	/api/surveys/{id}/responses/columns	List the columns of the response table (requires analytics.view)
ResponseFlagSummary	GET	/api/surveys/{id}/responses/flag-summary	Flagged share of the recent completions (requires analytics.view)
ResponseSearch	POST	/api/surveys/{id}/responses/search	Search the responses of a survey (requires analytics.view)
Segment	GET	/api/segments	List the segments you can use (requires analytics.view)
Segment	POST	/api/segments	Save a filter combination as segment (requires analytics.view)
Segment	GET	/api/segments/{id}	Get a segment (requires analytics.view; private segments only for their creator)
Segment	PATCH	/api/segments/{id}	Rename a segment, change its filter or sharing (creator; shared segments also segments.manage = admin+)
Segment	DELETE	/api/segments/{id}	Delete a segment (creator; shared segments also segments.manage = admin+). Audit-logged (`segment.deleted`).
Session	GET	/api/auth/sessions	List the active sessions of the current user
Session	DELETE	/api/auth/sessions/{id}	Sign out one session
Session	POST	/api/auth/sessions/revoke-others	Sign out all other sessions ("log out everywhere else")
ShareLink	GET	/api/share-links/{id}	Get a results share link (requires analytics.share)
ShareLink	POST	/api/share-links/{id}/revoke	Revoke a results share link (requires analytics.share)
ShareLink	GET	/api/surveys/{id}/share-links	List the results share links of a survey, newest first (requires analytics.share)
ShareLink	POST	/api/surveys/{id}/share-links	Create a results share link (requires analytics.share)
Survey	GET	/api/surveys	List the surveys of the active organization (requires surveys.view)
Survey	POST	/api/surveys	Create a draft (requires surveys.edit)
Survey	GET	/api/surveys/{id}	Get a survey with settings and structure (requires surveys.view)
Survey	PATCH	/api/surveys/{id}	Change title, description, project, theme or settings (requires surveys.edit)
Survey	DELETE	/api/surveys/{id}	Delete a draft (requires surveys.edit; other statuses: 409, archive them instead)
Survey	POST	/api/surveys/{id}/archive	Archive a survey (requires surveys.edit; idempotent)
Survey	POST	/api/surveys/{id}/close	Close a live or scheduled survey (requires surveys.publish; 409 from other statuses)
Survey	POST	/api/surveys/{id}/duplicate	Copy a survey with its complete structure as a new draft (requires surveys.edit)
Survey	POST	/api/surveys/{id}/extend	Extend a published survey by one year for one credit (requires surveys.publish)
Survey	POST	/api/surveys/{id}/publish	Publish the draft as a new version (requires surveys.publish and a confirmed e-mail address)
Survey	POST	/api/surveys/{id}/reopen	Reopen a closed survey: live, or scheduled if its start lies ahead (requires surveys.publish; 409 if not closed, the end of the current version has passed or the paid year is over)
Survey	POST	/api/surveys/{id}/restore	Take a survey out of the archive: closed if it was published, otherwise a draft (requires surveys.edit; 409 if not archived)
Survey	PUT	/api/surveys/{id}/structure	Replace the structure of the draft (requires surveys.edit)
SurveyChanges	GET	/api/surveys/{id}/changes	Compare the draft with the current version (requires surveys.view)
SurveyExport	GET	/api/surveys/{id}/export	Export the draft of a survey as a JSON document (requires surveys.view)
SurveyExport	POST	/api/surveys/import	Create a draft from an exported survey (requires surveys.edit)
SurveyRetention	GET	/api/surveys/{id}/retention	Get the retention period of a survey (requires surveys.view)
SurveyRetention	POST	/api/surveys/{id}/retention	Set the retention period of a survey (requires privacy.manage, admin+)
SurveyTemplate	GET	/api/survey-templates	List the built-in templates and those of the active organization (requires surveys.view)
SurveyTemplate	POST	/api/survey-templates	Save a survey of the organization as template (requires surveys.edit)
SurveyTemplate	GET	/api/survey-templates/{id}	Preview a template with its pages and questions (requires surveys.view)
SurveyTemplate	PATCH	/api/survey-templates/{id}	Rename an organization template or change its description or category (requires surveys.edit)
SurveyTemplate	DELETE	/api/survey-templates/{id}	Delete an organization template; surveys created from it stay (requires surveys.edit; built-in templates: 409)
SurveyTemplate	POST	/api/survey-templates/{id}/use	Create an editable draft from a template (requires surveys.edit)
SurveyTranslations	GET	/api/surveys/{id}/translations	Get the languages and translations of the draft (requires surveys.view)
SurveyTranslations	PUT	/api/surveys/{id}/translations	Replace the languages and translations of the draft (requires surveys.edit)
SurveyTranslations	POST	/api/surveys/{id}/translations/pretranslate	Pre-translate texts of a language with DeepL (requires surveys.edit)
SurveyVersion	GET	/api/surveys/{id}/versions	List the published versions of a survey, newest first (requires surveys.view)
SurveyVersion	GET	/api/surveys/{id}/versions/{number}	Get a version with its complete definition (requires surveys.view)
TextAnswerTagging	POST	/api/surveys/{id}/analytics/text-answers/tags	Add or remove tags of free-text answers (requires responses.manage)
TextTag	GET	/api/text-tags	List the organization's free-text tags by name (requires analytics.view)
TextTag	POST	/api/text-tags	Create a free-text tag (requires responses.manage)
TextTag	GET	/api/text-tags/{id}	Get a free-text tag (requires analytics.view)
TextTag	PATCH	/api/text-tags/{id}	Rename or recolour a free-text tag (requires responses.manage). Audit-logged (`text_tag.updated`).
TextTag	DELETE	/api/text-tags/{id}	Delete a free-text tag and all its assignments (requires responses.manage). Audit-logged (`text_tag.deleted`).
Theme	GET	/api/themes	List the themes of the organization (requires surveys.view)
Theme	POST	/api/themes	Create a theme (requires surveys.edit)
Theme	GET	/api/themes/{id}	Get a theme (requires surveys.view)
Theme	PATCH	/api/themes/{id}	Change a theme (requires surveys.edit)
Theme	DELETE	/api/themes/{id}	Delete a theme (requires surveys.edit)
ThemePreset	GET	/api/themes/presets	List the built-in themes
TwoFactorBackupCodes	POST	/api/me/two-factor/backup-codes	Regenerate the backup codes
TwoFactorBackupCodes	POST	/api/me/two-factor/enable	Enable two-factor authentication
TwoFactorDisable	POST	/api/me/two-factor/disable	Disable two-factor authentication
TwoFactorSetup	POST	/api/me/two-factor/setup	Start the two-factor setup
VerificationResend	POST	/api/auth/verify-email/resend	Send the verification e-mail again
Webhook	GET	/api/webhooks	List the webhook endpoints of the active organization (requires webhooks.manage)
Webhook	POST	/api/webhooks	Create a webhook endpoint (requires webhooks.manage)
Webhook	GET	/api/webhooks/{id}	Get a webhook endpoint (requires webhooks.manage)
Webhook	PATCH	/api/webhooks/{id}	Change a webhook endpoint, disable or enable it (requires webhooks.manage)
Webhook	DELETE	/api/webhooks/{id}	Delete a webhook endpoint with its delivery log (requires webhooks.manage). Audit-logged (`webhook.deleted`).
Webhook	POST	/api/webhooks/{id}/reveal-secret	Show the signing secret of a webhook endpoint (requires webhooks.manage)
Webhook	POST	/api/webhooks/{id}/rotate-secret	Replace the signing secret (requires webhooks.manage)
WebhookDelivery	GET	/api/webhook-deliveries/{id}	Get a webhook delivery with request body and attempts (requires webhooks.manage)
WebhookDelivery	POST	/api/webhook-deliveries/{id}/resend	Send the event of a delivery again (requires webhooks.manage)
WebhookDelivery	GET	/api/webhooks/{webhookId}/deliveries	Delivery log of a webhook endpoint (requires webhooks.manage)
WebhookDelivery	POST	/api/webhooks/{webhookId}/test	Send a test event to a webhook endpoint (requires webhooks.manage)

TypeScript-Client

Für TypeScript-Projekte gibt es einen typisierten Client:

import { createPollyouClient } from '@pollyou/api-client'

const api = createPollyouClient({
  baseUrl: 'https://api.pollyou.example',
  getAccessToken: () => sessionToken,
})

const { data, error } = await api.GET('/health')