View all methods

snapshots.settings.configuration

Read Snapshot scheduling, languages, lifecycle messages, and scheduled nudges. This method does not change configuration.

Facts


Method	`GET https://api.getdx.com/snapshots.settings.configuration`
Required scope	`snapshots:admin`

Arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.

settings_locked indicates a live snapshot. Snapshot dates and senders are null when unavailable. Nudge audience sizes are estimates and may be null.

Example request

curl -X GET https://api.getdx.com/snapshots.settings.configuration \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

{
  "ok": true,
  "configuration": {
    "fallback_timezone": "Europe/London",
    "eligible_participant_count": 100,
    "settings_locked": false,
    "live_snapshot": null,
    "next_snapshot": null,
    "languages": {
      "default": "en",
      "translation_locales": []
    },
    "lifecycle_messages": {
      "welcome": {
        "message": "Please share your feedback.",
        "message_format": "slack_mrkdwn",
        "sender": null
      },
      "heads_up": {
        "message": "A snapshot is coming soon.",
        "message_format": "slack_mrkdwn",
        "sender": null,
        "enabled": true,
        "applicable": true
      },
      "triage": {
        "message": "Please review your results.",
        "message_format": "slack_mrkdwn",
        "sender": null
      }
    },
    "scheduled_nudges": {
      "reference_snapshot_id": null,
      "estimate_basis": null,
      "items": []
    }
  }
}

Errors

not_authed or not_authorized for missing authentication or access. Unsupported arguments return 422 validation_error.