Skip to main content

​
Utilities and Support APIs

This module groups operational helper APIs used across dashboard UX.

​
Endpoint matrix

FeatureMethodPathPurpose
FX ratesGET/fx-ratesReturn current currency table
FX conversionGET/fx-rates/convertPreview conversion for amount/from/to
Notification prefsGET/notification-preferencesFetch account email notification settings
Notification prefsPATCH/notification-preferencesUpdate notification toggles
FeedbackPOST/feedbackSubmit bug/feature/general feedback
MetatagsGET/metatagsFetch title/description/image from destination URL
Email logsGET/email-logsList workspace email delivery history
WrappedGET/wrapped/:yearWorkspace year-in-review analytics
Wrapped shareGET/wrapped/share/:workspaceSlug/:yearPublic limited wrapped share payload
API docsGET/docsInteractive API docs UI
OpenAPI specGET/docs/openapi.jsonRaw OpenAPI JSON
PlaygroundGET/playgroundInteractive API playground

​
Authentication and permissions

  • fx-rates/*: workspace auth + analytics:read
  • notification-preferences/*: user session auth
  • /feedback: user session auth
  • /metatags: authenticated user
  • /email-logs: workspace auth + workspace:read
  • /wrapped/:year: workspace auth
  • /wrapped/share/*: public endpoint
  • /docs, /docs/openapi.json, /playground: public read endpoints

​
Input and validation highlights

  • /fx-rates/convert requires positive amount; unknown currency returns UNSUPPORTED_CURRENCY.
  • /feedback validates type, subject, and message; rate-limited per user.
  • /metatags requires a safe/valid URL.
  • /email-logs supports filter params (type, status) and pagination.
  • /wrapped/:year accepts 4-digit years and enforces range constraints.
  • /playground supports sandbox/live modes in UI; live execution requires a valid API key.

​
Typical failure classes

  • 400 validation errors (invalid params/body)
  • 401 unauthenticated access
  • 403 permission/entitlement mismatch
  • 429 rate-limit protection on feedback
  • 500 provider/internal failures
Related docs:
  • /user-guides/manual/workspace/settings-and-preferences
  • /user-guides/manual/workspace/workspace-settings-and-governance-reference
  • /user-guides/manual/data/analytics-views-reference