Skip to main content
Early Access - The Dcycle CLI is currently available for enterprise customers. Contact us to learn more about access.

Overview

The survey command sends and manages employee mobility surveys to collect commuting data for Scope 3 Category 7 calculations. Surveys are emailed to employees who fill in their commuting patterns (transport mode, distance, frequency).
dcy survey <subcommand> [flags]

Available Commands

CommandDescription
sendSend mobility surveys to employees
resendResend surveys to pending employees
listList survey employees and their status

Send Surveys

Send surveys to one or more employees. Creates the employee record and sends the survey email in one step.
dcy survey send <emails> [flags]

Examples

# Single employee
dcy survey send "jane@company.com" --start-date 2024-01-01 --end-date 2024-12-31

# Multiple employees (comma-separated)
dcy survey send "jane@company.com,john@company.com" --start-date 2024-01-01 --end-date 2024-12-31

# In a different language
dcy survey send "user@company.com" --start-date 2024-01-01 --end-date 2024-12-31 --lang en

# With a custom subject line
dcy survey send "team@company.com" --start-date 2024-01-01 --end-date 2024-12-31 --subject "Your commuting survey"

Flags

FlagShortRequiredDefaultDescription
--start-dateYesSurvey period start (YYYY-MM-DD)
--end-dateYesSurvey period end (YYYY-MM-DD)
--lang-lNoesSurvey language (es, en, pt, ca, fr, de, it)
--subject-sNoCustom email subject line
--orgNoOrganization ID override

Resend Surveys

Resend survey emails to employees who haven’t completed them. Does not create new employee records — only re-sends the survey email.
dcy survey resend <emails> [flags]

Examples

dcy survey resend "jane@company.com" --start-date 2024-01-01 --end-date 2024-12-31

# Change language on resend
dcy survey resend "jane@company.com,john@company.com" --start-date 2024-01-01 --end-date 2024-12-31 --lang en

Flags

Same flags as send except --subject.

List Survey Employees

View employees and their survey status.
dcy survey list [flags]

# Aliases
dcy survey ls

Examples

# List all survey employees
dcy survey list

# Filter by status
dcy survey list --status pending
dcy survey list --status loading

# Pagination
dcy survey list --page 2 --size 100

# JSON output for scripting
dcy survey list --format json

Flags

FlagShortDefaultDescription
--status-sFilter by status (pending, loading, active)
--page1Page number
--size50Page size
--orgOrganization ID override
Use dcy survey list --status pending to find employees who haven’t completed their survey, then dcy survey resend to nudge them.

Common Options

All survey commands support:
FlagDescription
--format jsonJSON output (default: text)
--verboseShow HTTP request/response details
--timeoutRequest timeout in seconds

Workflows

Employee Commuting Data Collection

# 1. Send surveys to all employees for the current year
dcy survey send "alice@company.com,bob@company.com,carol@company.com" \
  --start-date 2024-01-01 --end-date 2024-12-31 --lang en

# 2. Check who hasn't responded
dcy survey list --status pending

# 3. Resend to non-respondents
dcy survey resend "bob@company.com" \
  --start-date 2024-01-01 --end-date 2024-12-31

# 4. Review collected commute data
dcy employee list --year 2024