Member Junction
    Preparing search index...

    Class GetTypeformStatisticsAction

    Action to calculate aggregate statistics from Typeform responses

    Security: API credentials are retrieved securely from Company Integrations table or environment variables. Never pass API tokens as action parameters.

    await runAction({
      ActionName: 'Get Typeform Response Statistics',
      Params: [{
        Name: 'CompanyID',
        Value: '12345'
      }, {
        Name: 'FormID',
        Value: 'abc123'
      }, {
        Name: 'Since',
        Value: '2024-01-01T00:00:00Z'
      }]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    apiBaseUrl Description formPlatform integrationName Params

    Methods

    buildFormErrorMessage calculateAverageCompletionTime calculateCompletionRate convertToCSV createOAuth2Manager extractEmailFromResponses findTopAnswers formatDuration formatFormDate formatTypeformDate getAllTypeformResponses getAPICredentials getAxiosInstance getCommonFormParams getCompanyIntegration getCredentialFromEnv getFormDetails getParamValue getSecureAPIToken getSingleTypeformResponse getTypeformResponses groupResponsesByDate handleTypeformError InternalRunAction normalizeTypeformResponse parseFormDate parseTypeformDate Run sleep

    Constructors

    Accessors

    Methods

    • Get all responses with automatic pagination

      Parameters

      • formId: string
      • apiToken: string
      • Optionaloptions: {
            completed?: boolean;
            maxResponses?: number;
            query?: string;
            since?: string;
            sort?: string;
            until?: string;
        }

      Returns Promise<TypeformResponseItem[]>

    • 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

    • 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

      Error if no credentials are found or company integration is not configured

    • Get responses from a Typeform

      Parameters

      • formId: string
      • apiToken: string
      • Optionaloptions: {
            after?: string;
            before?: string;
            completed?: boolean;
            fields?: string[];
            pageSize?: number;
            query?: string;
            since?: string;
            sort?: string;
            until?: string;
        }

      Returns Promise<TypeformResponsesResult>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods