Class GetSurveyMonkeyResponsesAction

Action to retrieve responses from a SurveyMonkey survey with comprehensive filtering options

Security: Uses secure credential lookup via CompanyID instead of accepting tokens directly.

Example

await runAction({
  ActionName: 'Get SurveyMonkey Responses',
  Params: [{
    Name: 'CompanyID',
    Value: 'your-company-id'
  }, {
    Name: 'SurveyID',
    Value: '12345678'
  }, {
    Name: 'StartCreatedAt',
    Value: '2024-01-01T00:00:00Z'
  }, {
    Name: 'Status',
    Value: 'completed'
  }]
});

Hierarchy (View Summary)

SurveyMonkeyBaseAction
- GetSurveyMonkeyResponsesAction

Constructors

constructor

new GetSurveyMonkeyResponsesAction(): GetSurveyMonkeyResponsesAction
Returns GetSurveyMonkeyResponsesAction
Inherited from SurveyMonkeyBaseAction.constructor

Accessors

`Protected`apiBaseUrl

get apiBaseUrl(): string
Returns string
Inherited from SurveyMonkeyBaseAction.apiBaseUrl
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:111

Description

get Description(): string
Returns string
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/actions/get-responses.action.ts:35

`Protected`formPlatform

get formPlatform(): string
The form platform this action is designed for (e.g., 'Typeform', 'Google Forms', etc.)

Returns string
Inherited from SurveyMonkeyBaseAction.formPlatform
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:103

`Protected`integrationName

get integrationName(): string
The integration name to look up in the Integration entity

Returns string
Inherited from SurveyMonkeyBaseAction.integrationName
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:107

Params

get Params(): ActionParam[]
Returns ActionParam[]
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/actions/get-responses.action.ts:176

Methods

`Protected`buildFormErrorMessage

buildFormErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for form operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
Inherited from SurveyMonkeyBaseAction.buildFormErrorMessage
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:289

`Protected`calculateAverageCompletionTime

calculateAverageCompletionTime(responses: FormResponse[]): number
Calculate average completion time from responses
Parameters
- responses: FormResponse[]
Returns number
Inherited from SurveyMonkeyBaseAction.calculateAverageCompletionTime
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:333

`Protected`calculateCompletionRate

calculateCompletionRate(completed: number, total: number): number
Calculate completion rate percentage
Parameters
- completed: number
- total: number
Returns number
Inherited from SurveyMonkeyBaseAction.calculateCompletionRate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:263

`Protected`convertToCSV

convertToCSV(
    responses: FormResponse[],
    includeMetadata?: boolean,
    delimiter?: string,
): { csv: string; headers: string[] }
Convert responses to CSV format
Parameters
- responses: FormResponse[]
- includeMetadata: boolean = false
- delimiter: string = ','
Returns { csv: string; headers: string[] }
Inherited from SurveyMonkeyBaseAction.convertToCSV
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:382

`Protected`createOAuth2Manager

createOAuth2Manager(
companyId: string,
contextUser: UserInfo,
): Promise<OAuth2Manager>
Creates an OAuth2Manager instance for the specified company. Override this method in provider-specific base classes to configure OAuth2 endpoints.
Parameters
- companyId: string
  The MemberJunction company ID
- contextUser: UserInfo
  The user context
Returns Promise<OAuth2Manager>
OAuth2Manager instance or null if OAuth2 is not configured
Inherited from SurveyMonkeyBaseAction.createOAuth2Manager
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:221

`Protected`createSurveyMonkeyCollector

createSurveyMonkeyCollector(
    surveyId: string,
    accessToken: string,
    collectorData: {
        name: string;
        redirect_url?: string;
        thank_you_message?: string;
        type: "email" | "weblink";
    },
): Promise<SurveyMonkeyCollector>
Create a new collector for a survey
Parameters
- surveyId: string
- accessToken: string
- collectorData: {
      name: string;
      redirect_url?: string;
      thank_you_message?: string;
      type: "email" | "weblink";
  }
Returns Promise<SurveyMonkeyCollector>
Inherited from SurveyMonkeyBaseAction.createSurveyMonkeyCollector
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:339

`Protected`extractEmailFromResponses

extractEmailFromResponses(responses: FormResponse[]): string[]
Extract email addresses from response answers
Parameters
- responses: FormResponse[]
Returns string[]
Inherited from SurveyMonkeyBaseAction.extractEmailFromResponses
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:300

`Protected`findTopAnswers

findTopAnswers(
    responses: FormResponse[],
    fieldId: string,
    limit?: number,
): { answer: string; count: number }[]
Find most common answers for choice fields
Parameters
- responses: FormResponse[]
- fieldId: string
- limit: number = 10
Returns { answer: string; count: number }[]
Inherited from SurveyMonkeyBaseAction.findTopAnswers
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:356

`Protected`formatDuration

formatDuration(seconds: number): string
Format duration in seconds to human readable format
Parameters
- seconds: number
Returns string
Inherited from SurveyMonkeyBaseAction.formatDuration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:271

`Protected`formatFormDate

formatFormDate(date: Date): string
Standard date format for form platforms (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from SurveyMonkeyBaseAction.formatFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:246

`Protected`formatSurveyMonkeyDate

formatSurveyMonkeyDate(date: Date): string
Format date for SurveyMonkey API (ISO 8601 format)
Parameters
- date: Date
Returns string
Inherited from SurveyMonkeyBaseAction.formatSurveyMonkeyDate
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:496

`Protected`getAllSurveyMonkeyResponses

getAllSurveyMonkeyResponses(
    surveyId: string,
    accessToken: string,
    options?: {
        end_created_at?: string;
        end_modified_at?: string;
        maxResponses?: number;
        sort_by?: "date_modified" | "date_created";
        sort_order?: "ASC" | "DESC";
        start_created_at?: string;
        start_modified_at?: string;
        status?: "completed" | "partial" | "overquota" | "disqualified";
    },
): Promise<SurveyMonkeyResponse[]>
Get all responses with automatic pagination
Parameters
- surveyId: string
- accessToken: string
- Optionaloptions: {
      end_created_at?: string;
      end_modified_at?: string;
      maxResponses?: number;
      sort_by?: "date_modified" | "date_created";
      sort_order?: "ASC" | "DESC";
      start_created_at?: string;
      start_modified_at?: string;
      status?: "completed" | "partial" | "overquota" | "disqualified";
  }
Returns Promise<SurveyMonkeyResponse[]>
Inherited from SurveyMonkeyBaseAction.getAllSurveyMonkeyResponses
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:200

`Protected`getAPICredentials

getAPICredentials(
integration: MJCompanyIntegrationEntity,
): Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Gets API credentials - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Inherited from SurveyMonkeyBaseAction.getAPICredentials
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:148

`Protected`getAxiosInstance

getAxiosInstance(accessToken: string): AxiosInstance
Get axios instance with SurveyMonkey authentication
Parameters
- accessToken: string
Returns AxiosInstance
Inherited from SurveyMonkeyBaseAction.getAxiosInstance
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:121

`Protected`getCommonFormParams

getCommonFormParams(): ActionParam[]
Common form builder parameters that many actions will need. CompanyID is required for secure credential lookup. FormID is the platform-specific form identifier.

Returns ActionParam[]
Inherited from SurveyMonkeyBaseAction.getCommonFormParams
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:78

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and form platform
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
Inherited from SurveyMonkeyBaseAction.getCompanyIntegration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:96

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_TYPEFORM_12345_API_TOKEN

Falls back to: BIZAPPS_{PROVIDER}_{CREDENTIAL_TYPE} if no company-specific credential found Example fallback: BIZAPPS_TYPEFORM_API_TOKEN
Parameters
- companyId: string
- credentialType: string
Returns string
Inherited from SurveyMonkeyBaseAction.getCredentialFromEnv
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:128

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value with type safety
Parameters
- params: ActionParam[]
- paramName: string
Returns any
Inherited from SurveyMonkeyBaseAction.getParamValue
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:238

`Protected`getSecureAPIToken

getSecureAPIToken(companyId: string, contextUser: UserInfo): Promise<string>
Helper to securely retrieve API token for a company. This method should be used by all form builder actions instead of accepting tokens as parameters.
Parameters
- companyId: string
  The MemberJunction company ID (required)
- contextUser: UserInfo
  The user context for database queries
Returns Promise<string>
The API token for the specified company

Throws
Error if no credentials are found or company integration is not configured
Inherited from SurveyMonkeyBaseAction.getSecureAPIToken
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:183

`Protected`getSingleSurveyMonkeyResponse

getSingleSurveyMonkeyResponse(
    surveyId: string,
    responseId: string,
    accessToken: string,
): Promise<SurveyMonkeyResponse>
Get a single response by ID with detailed information
Parameters
- surveyId: string
- responseId: string
- accessToken: string
Returns Promise<SurveyMonkeyResponse>
Inherited from SurveyMonkeyBaseAction.getSingleSurveyMonkeyResponse
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:262

`Protected`getSurveyMonkeyCollectors

getSurveyMonkeyCollectors(
surveyId: string,
accessToken: string,
): Promise<SurveyMonkeyCollector[]>
Get collectors for a survey
Parameters
- surveyId: string
- accessToken: string
Returns Promise<SurveyMonkeyCollector[]>
Inherited from SurveyMonkeyBaseAction.getSurveyMonkeyCollectors
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:320

`Protected`getSurveyMonkeyDetails

getSurveyMonkeyDetails(
surveyId: string,
accessToken: string,
): Promise<SurveyMonkeySurveyDetails>
Get survey details
Parameters
- surveyId: string
- accessToken: string
Returns Promise<SurveyMonkeySurveyDetails>
Inherited from SurveyMonkeyBaseAction.getSurveyMonkeyDetails
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:282

`Protected`getSurveyMonkeyPages

getSurveyMonkeyPages(surveyId: string, accessToken: string): Promise<any>
Get survey pages and questions for detailed response normalization
Parameters
- surveyId: string
- accessToken: string
Returns Promise<any>
Inherited from SurveyMonkeyBaseAction.getSurveyMonkeyPages
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:301

`Protected`getSurveyMonkeyResponses

getSurveyMonkeyResponses(
    surveyId: string,
    accessToken: string,
    options?: {
        end_created_at?: string;
        end_modified_at?: string;
        page?: number;
        per_page?: number;
        sort_by?: "date_modified" | "date_created";
        sort_order?: "ASC" | "DESC";
        start_created_at?: string;
        start_modified_at?: string;
        status?: "completed" | "partial" | "overquota" | "disqualified";
    },
): Promise<SurveyMonkeyResponsesResult>
Get responses from a SurveyMonkey survey
Parameters
- surveyId: string
- accessToken: string
- Optionaloptions: {
      end_created_at?: string;
      end_modified_at?: string;
      page?: number;
      per_page?: number;
      sort_by?: "date_modified" | "date_created";
      sort_order?: "ASC" | "DESC";
      start_created_at?: string;
      start_modified_at?: string;
      status?: "completed" | "partial" | "overquota" | "disqualified";
  }
Returns Promise<SurveyMonkeyResponsesResult>
Inherited from SurveyMonkeyBaseAction.getSurveyMonkeyResponses
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:156

`Protected`groupResponsesByDate

groupResponsesByDate(responses: FormResponse[]): Record<string, number>
Group responses by date
Parameters
- responses: FormResponse[]
Returns Record<string, number>
Inherited from SurveyMonkeyBaseAction.groupResponsesByDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:319

`Protected`handleSurveyMonkeyError

handleSurveyMonkeyError(error: any): Error
Handle SurveyMonkey-specific errors
Parameters
- error: any
Returns Error
Inherited from SurveyMonkeyBaseAction.handleSurveyMonkeyError
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:462

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides SurveyMonkeyBaseAction.InternalRunAction
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/actions/get-responses.action.ts:39

`Protected`normalizeSurveyMonkeyResponse

normalizeSurveyMonkeyResponse(smResponse: SurveyMonkeyResponse): FormResponse
Normalize SurveyMonkey response to common format
Parameters
- smResponse: SurveyMonkeyResponse
Returns FormResponse
Inherited from SurveyMonkeyBaseAction.normalizeSurveyMonkeyResponse
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:397

`Protected`parseFormDate

parseFormDate(dateString: string | number): Date
Parse date from form platform format
Parameters
- dateString: string | number
Returns Date
Inherited from SurveyMonkeyBaseAction.parseFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:253

`Protected`parseSurveyMonkeyDate

parseSurveyMonkeyDate(dateValue: string): Date
Parse SurveyMonkey date string
Parameters
- dateValue: string
Returns Date
Inherited from SurveyMonkeyBaseAction.parseSurveyMonkeyDate
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:503

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from SurveyMonkeyBaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:37

`Protected`sleep

sleep(ms: number): Promise<void>
Sleep helper for rate limiting
Parameters
- ms: number
Returns Promise<void>
Inherited from SurveyMonkeyBaseAction.sleep
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:489

`Protected`updateSurveyMonkey

updateSurveyMonkey(
    surveyId: string,
    accessToken: string,
    updateData: {
        buttons_text?: {
            done_button?: string;
            exit_button?: string;
            next_button?: string;
            prev_button?: string;
        };
        custom_variables?: Record<string, string>;
        language?: string;
        nickname?: string;
        title?: string;
    },
): Promise<SurveyMonkeySurveyDetails>
Update survey details
Parameters
- surveyId: string
- accessToken: string
- updateData: {
      buttons_text?: {
          done_button?: string;
          exit_button?: string;
          next_button?: string;
          prev_button?: string;
      };
      custom_variables?: Record<string, string>;
      language?: string;
      nickname?: string;
      title?: string;
  }
Returns Promise<SurveyMonkeySurveyDetails>
Inherited from SurveyMonkeyBaseAction.updateSurveyMonkey
- Defined in BizApps/FormBuilders/src/providers/surveymonkey/surveymonkey-base.action.ts:365

Class GetSurveyMonkeyResponsesAction

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns GetSurveyMonkeyResponsesAction

Accessors

ProtectedapiBaseUrl

Returns string

Description

Returns string

ProtectedformPlatform

Returns string

ProtectedintegrationName

Returns string

Params

Returns ActionParam[]

Methods

ProtectedbuildFormErrorMessage

Parameters

Returns string

ProtectedcalculateAverageCompletionTime

Parameters

Returns number

ProtectedcalculateCompletionRate

Parameters

Returns number

ProtectedconvertToCSV

Parameters

Returns { csv: string; headers: string[] }

ProtectedcreateOAuth2Manager

Parameters

Returns Promise<OAuth2Manager>

ProtectedcreateSurveyMonkeyCollector

Parameters

Returns Promise<SurveyMonkeyCollector>

ProtectedextractEmailFromResponses

Parameters

Returns string[]

ProtectedfindTopAnswers

Parameters

Returns { answer: string; count: number }[]

ProtectedformatDuration

Parameters

Returns string

ProtectedformatFormDate

Parameters

Returns string

ProtectedformatSurveyMonkeyDate

Parameters

Returns string

ProtectedgetAllSurveyMonkeyResponses

Parameters

Returns Promise<SurveyMonkeyResponse[]>

ProtectedgetAPICredentials

Parameters

Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>

ProtectedgetAxiosInstance

Parameters

Returns AxiosInstance

ProtectedgetCommonFormParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetParamValue

Parameters

Returns any

ProtectedgetSecureAPIToken

Parameters

Returns Promise<string>

Throws

ProtectedgetSingleSurveyMonkeyResponse

`Protected`apiBaseUrl

`Protected`formPlatform

`Protected`integrationName

`Protected`buildFormErrorMessage

`Protected`calculateAverageCompletionTime

`Protected`calculateCompletionRate

`Protected`convertToCSV

`Protected`createOAuth2Manager

`Protected`createSurveyMonkeyCollector

`Protected`extractEmailFromResponses

`Protected`findTopAnswers

`Protected`formatDuration

`Protected`formatFormDate

`Protected`formatSurveyMonkeyDate

`Protected`getAllSurveyMonkeyResponses

`Protected`getAPICredentials

`Protected`getAxiosInstance

`Protected`getCommonFormParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getParamValue

`Protected`getSecureAPIToken

`Protected`getSingleSurveyMonkeyResponse

`Protected`getSurveyMonkeyCollectors

`Protected`getSurveyMonkeyDetails

`Protected`getSurveyMonkeyPages

`Protected`getSurveyMonkeyResponses

`Protected`groupResponsesByDate

`Protected`handleSurveyMonkeyError

`Protected`InternalRunAction

`Protected`normalizeSurveyMonkeyResponse

`Protected`parseFormDate

`Protected`parseSurveyMonkeyDate

`Protected`sleep

`Protected`updateSurveyMonkey