From 27e5c529439e739f12f23aff3bdf905046b8df3a Mon Sep 17 00:00:00 2001 From: Lucie Milan <32450552+lmilan@users.noreply.github.com> Date: Tue, 3 Oct 2023 17:48:10 +0200 Subject: [PATCH] TDL-24120 SurveyMonkey: add surveys stream (#955) * TDL-24120 add surveys stream * fixed indentation * update for v2 --- .../2023/2023-10-03-surveymonkey-v2.md | 15 + _data/taps/versions/surveymonkey.yml | 9 +- .../surveymonkey/{ => v1}/foreign-keys.md | 0 .../surveymonkey/{ => v1}/responses.md | 0 .../{ => v1}/simplified_responses.md | 0 .../surveymonkey/{ => v1}/survey_details.md | 0 .../surveymonkey/v2/foreign-keys.md | 34 ++ .../surveymonkey/v2/responses.md | 154 ++++++ .../surveymonkey/v2/simplified_responses.md | 161 +++++++ .../surveymonkey/v2/survey_details.md | 450 ++++++++++++++++++ .../surveymonkey/v2/surveys.md | 47 ++ .../surveymonkey/v1/surveymonkey-v1.md | 4 +- .../surveymonkey/v2/surveymonkey-v2.md | 147 ++++++ 13 files changed, 1018 insertions(+), 3 deletions(-) create mode 100644 _changelog-files/2023/2023-10-03-surveymonkey-v2.md rename _integration-schemas/surveymonkey/{ => v1}/foreign-keys.md (100%) rename _integration-schemas/surveymonkey/{ => v1}/responses.md (100%) rename _integration-schemas/surveymonkey/{ => v1}/simplified_responses.md (100%) rename _integration-schemas/surveymonkey/{ => v1}/survey_details.md (100%) create mode 100644 _integration-schemas/surveymonkey/v2/foreign-keys.md create mode 100644 _integration-schemas/surveymonkey/v2/responses.md create mode 100644 _integration-schemas/surveymonkey/v2/simplified_responses.md create mode 100644 _integration-schemas/surveymonkey/v2/survey_details.md create mode 100644 _integration-schemas/surveymonkey/v2/surveys.md create mode 100644 _saas-integrations/surveymonkey/v2/surveymonkey-v2.md diff --git a/_changelog-files/2023/2023-10-03-surveymonkey-v2.md b/_changelog-files/2023/2023-10-03-surveymonkey-v2.md new file mode 100644 index 000000000..b40a79145 --- /dev/null +++ b/_changelog-files/2023/2023-10-03-surveymonkey-v2.md @@ -0,0 +1,15 @@ +--- +title: "SurveyMonkey integration: New version (v2) now available!" +content-type: "changelog-entry" +date: 2023-10-03 +entry-type: new-feature +entry-category: integration +connection-id: surveymonkey +connection-version: 2 +pull-request: "https://github.com/singer-io/tap-surveymonkey/pull/27" +--- +{{ site.data.changelog.metadata.single-integration | flatify }} + +A new version (v{{ this-connection.this-version }}) of our {{ this-connection.display_name }} integration is now available! + +We've added a new `surveys` stream. \ No newline at end of file diff --git a/_data/taps/versions/surveymonkey.yml b/_data/taps/versions/surveymonkey.yml index f3792602e..763ad0eeb 100644 --- a/_data/taps/versions/surveymonkey.yml +++ b/_data/taps/versions/surveymonkey.yml @@ -11,9 +11,16 @@ # SURVEYMONKEY VERSIONS # # ------------------------- # -latest-version: "1" +latest-version: "2" released-versions: + - number: "2" + status: "released" ## beta, released, deprecated + date-released: "October 3, 2023" # Full release: September 2, 2020 + # date-last-connection: + deprecation-date: "" + sunset-date: "" + - number: "1" status: "released" ## beta, released, deprecated date-released: "February 26, 2020" # Full release: September 2, 2020 diff --git a/_integration-schemas/surveymonkey/foreign-keys.md b/_integration-schemas/surveymonkey/v1/foreign-keys.md similarity index 100% rename from _integration-schemas/surveymonkey/foreign-keys.md rename to _integration-schemas/surveymonkey/v1/foreign-keys.md diff --git a/_integration-schemas/surveymonkey/responses.md b/_integration-schemas/surveymonkey/v1/responses.md similarity index 100% rename from _integration-schemas/surveymonkey/responses.md rename to _integration-schemas/surveymonkey/v1/responses.md diff --git a/_integration-schemas/surveymonkey/simplified_responses.md b/_integration-schemas/surveymonkey/v1/simplified_responses.md similarity index 100% rename from _integration-schemas/surveymonkey/simplified_responses.md rename to _integration-schemas/surveymonkey/v1/simplified_responses.md diff --git a/_integration-schemas/surveymonkey/survey_details.md b/_integration-schemas/surveymonkey/v1/survey_details.md similarity index 100% rename from _integration-schemas/surveymonkey/survey_details.md rename to _integration-schemas/surveymonkey/v1/survey_details.md diff --git a/_integration-schemas/surveymonkey/v2/foreign-keys.md b/_integration-schemas/surveymonkey/v2/foreign-keys.md new file mode 100644 index 000000000..039d9c6df --- /dev/null +++ b/_integration-schemas/surveymonkey/v2/foreign-keys.md @@ -0,0 +1,34 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas-foreign-keys/ +## FOR INSTRUCTIONS & REFERENCE INFO + +tap-reference: "surveymonkey" + +version: "2" + +foreign-keys: + - id: "response-id" + table: "responses" + attribute: "id" + all-foreign-keys: + - table: "responses" + join-on: "id" + - table: "simplified_responses" + join-on: "id" + + - id: "survey-id" + table: "survey_details" + attribute: "id" + all-foreign-keys: + - table: "survey_details" + join-on: "id" + - table: "responses" + join-on: "survey_id" + - table: "simplified_responses" + join-on: "survey_id" +--- \ No newline at end of file diff --git a/_integration-schemas/surveymonkey/v2/responses.md b/_integration-schemas/surveymonkey/v2/responses.md new file mode 100644 index 000000000..7ac3ae56c --- /dev/null +++ b/_integration-schemas/surveymonkey/v2/responses.md @@ -0,0 +1,154 @@ +--- +tap: "surveymonkey" +version: "2" +key: "" + +name: "responses" +doc-link: "https://developer.surveymonkey.com/api/v3/" +singer-schema: "https://github.com/singer-io/tap-surveymonkey/blob/master/tap_surveymonkey/schemas/responses.json" +description: "This table contains information about your survey responses." + +replication-method: "Key-based Incremental" + +api-method: + name: "GET Survey Responses" + doc-link: "https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The response ID." + foreign-key-id: "response-id" + + - name: "date_modified" + type: "date-time" + description: "The date the response was last modified." + replication-key: true + + - name: "analyze_url" + type: "string" + description: "The weblink to the analyze page to view the response." + + - name: "collection_mode" + type: "string" + description: | + The collection mode of the response: `default`, `preview`, `data_entry`, `survey_preview`, or `edit`. + + - name: "collector_id" + type: "string" + description: "The ID of the collector the response was taken for." + + - name: "custom_value" + type: "string" + description: "The custom value associated with a response." + + - name: "custom_variables" + type: "object" + description: "The values to any available custom variables in the survey." + subattributes: + + - name: "date_created" + type: "date-time" + description: "The date the response was created." + + - name: "edit_url" + type: "string" + description: "The weblink to the survey taking page to edit the response." + + - name: "email_address" + type: "string" + description: "The email address of the responder." + + - name: "first_name" + type: "string" + description: "The first name of the responder." + + - name: "href" + type: "string" + description: "The **Resource API** URL." + + - name: "ip_address" + type: "string" + description: "The IP Address the response was taken from." + + - name: "last_name" + type: "string" + description: "The last name of the responder." + + - name: "logic_path" + type: "object" + description: "The logic path taken during the survey." + subattributes: + + - name: "metadata" + type: "object" + description: "Other associated metadata or custom values." + subattributes: + + - name: "page_path" + type: "array" + description: "The order in which the pages were responded to." + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "pages" + type: "array" + description: "Pages from the survey and their associated responses." + subattributes: + - name: "id" + type: "string" + description: "The ID of the page with responses." + - name: "questions" + type: "array" + description: "The questions on that page with responses." + subattributes: + - name: "answers" + type: "array" + description: "The answers for the question with responses." + subattributes: + - name: "choice_id" + type: "string" + description: "The choice selected." + - name: "col_id" + type: "string" + description: "The column selected." + - name: "image" + type: "string" + description: "" + - name: "other_id" + type: "string" + description: "The other text choice selected." + - name: "row_id" + type: "string" + description: "The row selected." + - name: "text" + type: "string" + description: "Any open ended text." + - name: "id" + type: "string" + description: "ID of the question with responses." + - name: "variable_id" + type: "string" + description: "ID of the random assignment variable for the question." + + - name: "recipient_id" + type: "string" + description: "The ID of the recipient." + + - name: "response_status" + type: "string" + description: | + The status of the response: `completed`, `partial`, `overquota`, or `disqualified`. + + - name: "survey_id" + type: "string" + description: "ID of the survey the response was taken for." + foreign-key-id: "survey-id" + + - name: "total_time" + type: "integer" + description: "Total time in seconds spent on the survey." +--- diff --git a/_integration-schemas/surveymonkey/v2/simplified_responses.md b/_integration-schemas/surveymonkey/v2/simplified_responses.md new file mode 100644 index 000000000..26852be2f --- /dev/null +++ b/_integration-schemas/surveymonkey/v2/simplified_responses.md @@ -0,0 +1,161 @@ +--- +tap: "surveymonkey" +version: "2" +key: "" + +name: "simplified_responses" +doc-link: "https://developer.surveymonkey.com/api/v3/" +singer-schema: "https://github.com/singer-io/tap-surveymonkey/blob/master/tap_surveymonkey/schemas/simplified_responses.json" +description: "This table contains a simplified version of information about your survey responses." + +replication-method: "Key-based Incremental" + +api-method: + name: "GET Response" + doc-link: "https://developer.surveymonkey.com/api/v3/#collectors-id-responses-id-details" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The response ID." + foreign-key-id: "response-id" + + - name: "date_modified" + type: "date-time" + description: "The date the response was last modified." + replication-key: true + + - name: "analyze_url" + type: "string" + description: "The weblink to the analyze page to view the response." + + - name: "collection_mode" + type: "string" + description: | + The collection mode of the response: `default`, `preview`, `data_entry`, `survey_preview`, or `edit`. + + - name: "collector_id" + type: "string" + description: "The ID of the collector the response was taken for." + + - name: "custom_value" + type: "string" + description: "The custom value associated with a response." + + - name: "custom_variables" + type: "object" + description: "The values to any available custom variables in the survey." + subattributes: + + - name: "date_created" + type: "date-time" + description: "The date the response was created." + + - name: "edit_url" + type: "string" + description: "The weblink to the survey taking page to edit the response." + + - name: "href" + type: "string" + description: "The **Resource API** URL." + + - name: "ip_address" + type: "string" + description: "The IP Address the response was taken from." + + - name: "logic_path" + type: "object" + description: "The logic path taken during the survey." + subattributes: + + - name: "metadata" + type: "object" + description: "Other associated metadata or custom values." + subattributes: + + - name: "page_path" + type: "array" + description: "The order in which the pages were responded to." + subattributes: + - name: "value" + type: "string" + description: "" + + - name: "pages" + type: "array" + description: "Pages from the survey and their associated responses." + subattributes: + - name: "id" + type: "string" + description: "The ID of the page with responses." + - name: "questions" + type: "array" + description: "The questions on that page with responses." + subattributes: + - name: "answers" + type: "array" + description: "The answers for the question with responses." + subattributes: + - name: "choice_id" + type: "string" + description: "The choice selected." + - name: "col_id" + type: "string" + description: "The column selected." + - name: "image" + type: "string" + description: "" + - name: "other_id" + type: "string" + description: "The other text choice selected." + - name: "row_id" + type: "string" + description: "The row selected." + - name: "simple_text" + type: "string" + description: "" + - name: "tag_data" + type: "array" + description: "" + subattributes: + - name: "value" + type: "string" + description: "" + - name: "text" + type: "string" + description: "Any open ended text." + - name: "family" + type: "string" + description: "The question family." + - name: "heading" + type: "string" + description: "The question heading." + - name: "id" + type: "string" + description: "ID of the question with responses." + - name: "subtype" + type: "string" + description: "The question family's subtype." + - name: "variable_id" + type: "string" + description: "ID of the random assignment variable for the question." + + - name: "recipient_id" + type: "string" + description: "The ID of the recipient." + + - name: "response_status" + type: "string" + description: | + The status of the response: `completed`, `partial`, `overquota`, or `disqualified`. + + - name: "survey_id" + type: "string" + description: "ID of the survey the response was taken for." + foreign-key-id: "survey-id" + + - name: "total_time" + type: "integer" + description: "Total time in seconds spent on the survey." +--- diff --git a/_integration-schemas/surveymonkey/v2/survey_details.md b/_integration-schemas/surveymonkey/v2/survey_details.md new file mode 100644 index 000000000..db587882b --- /dev/null +++ b/_integration-schemas/surveymonkey/v2/survey_details.md @@ -0,0 +1,450 @@ +--- +tap: "surveymonkey" +version: "2" +key: "" + +name: "survey_details" +doc-link: "https://developer.surveymonkey.com/api/v3/" +singer-schema: "https://github.com/singer-io/tap-surveymonkey/blob/master/tap_surveymonkey/schemas/survey_details.json" +description: "This table contains information about your survey details." + +replication-method: "Key-based Incremental" + +api-method: + name: "GET Surveys" + doc-link: "https://developer.surveymonkey.com/api/v3/#surveys" + +attributes: + - name: "id" + type: "string" + primary-key: true + description: "The survey ID." + foreign-key-id: "survey-id" + + - name: "date_modified" + type: "date-time" + description: "The date and time when survey was last modified." + replication-key: true + + - name: "analyze_url" + type: "string" + description: "The survey's **Analyze** URL." + + - name: "buttons_text" + type: "object" + description: "The survey buttons text container." + subattributes: + - name: "done_button" + type: "string" + description: "The **Done** button text." + - name: "exit_button" + type: "string" + description: "The **Exit** button text." + - name: "next_button" + type: "string" + description: "The **Next** button text." + - name: "prev_button" + type: "string" + description: "The **Previous** button text." + + - name: "category" + type: "string" + description: "The survey category chosen when creating the survey." + + - name: "collect_url" + type: "string" + description: "The survey's **Collect** URL." + + - name: "custom_variables" + type: "object" + description: "The dictionary of survey variables." + subattributes: + + - name: "date_created" + type: "date-time" + description: "The date and time when survey was created" + + - name: "edit_url" + type: "string" + description: "The survey's **Edit** URL." + + - name: "folder_id" + type: "string" + description: "If applicable, the id of the folder the survey is in." + + - name: "footer" + type: "boolean" + description: "Whether or not SurveyMonkey’s footer is **not** displayed." + + - name: "href" + type: "string" + description: "The **Resource API** URL." + + - name: "is_owner" + type: "boolean" + description: "" + + - name: "language" + type: "string" + description: "The survey language." + + - name: "nickname" + type: "string" + description: "The survey nickname." + + - name: "page_count" + type: "integer" + description: "The number of pages in the survey." + + - name: "pages" + type: "array" + description: "Pages from the surveys." + subattributes: + - name: "description" + type: "string" + description: "The page description." + - name: "href" + type: "string" + description: "" + - name: "id" + type: "string" + description: "The page ID." + - name: "position" + type: "integer" + description: "The page position." + - name: "question_count" + type: "integer" + description: "The number of questions on the page." + - name: "questions" + type: "array" + description: "The questions on the page." + subattributes: + - name: "answers" + type: "object" + description: "The answer to the question." + subattributes: + - name: "choices" + type: "array" + description: "The list of available choices for the user." + subattributes: + - name: "description" + type: "string" + description: "Valid values: , Extremely likely, Not at all likely." + - name: "id" + type: "string" + description: "The ID of the choice" + - name: "image" + type: "object" + description: "The image choice." + subattributes: + - name: "s3_key" + type: "string" + description: "" + - name: "url" + type: "string" + description: "The URL of image choice." + - name: "is_na" + type: "boolean" + description: "" + - name: "position" + type: "integer" + description: "The position of the current choice" + - name: "quiz_options" + type: "object" + description: "The object containing the quiz properties of this question, if quiz-mode is enabled." + subattributes: + - name: "score" + type: "integer" + description: "The quiz score." + - name: "text" + type: "string" + description: "The choice for user selection." + - name: "visible" + type: "boolean" + description: "Whether the question is visible." + - name: "weight" + type: "integer" + description: "The weight value of the choice." + - name: "cols" + type: "array" + description: "The list of columns in the matrix." + subattributes: + - name: "choices" + type: "array" + description: "The list of available choices for the user in dropdown menu." + subattributes: + - name: "id" + type: "string" + description: "" + - name: "is_na" + type: "boolean" + description: "" + - name: "position" + type: "integer" + description: "The position of choice." + - name: "text" + type: "string" + description: "The choice for user selection." + - name: "visible" + type: "boolean" + description: "" + - name: "id" + type: "string" + description: "" + - name: "is_na" + type: "boolean" + description: "" + - name: "position" + type: "integer" + description: "" + - name: "text" + type: "string" + description: "" + - name: "visible" + type: "boolean" + description: "" + - name: "other" + type: "object" + description: "" + subattributes: + - name: "apply_all_rows" + type: "boolean" + description: "" + - name: "error_text" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "is_answer_choice" + type: "boolean" + description: "" + - name: "num_chars" + type: "integer" + description: "" + - name: "num_lines" + type: "integer" + description: "" + - name: "position" + type: "integer" + description: "" + - name: "text" + type: "string" + description: "" + - name: "visible" + type: "boolean" + description: "" + - name: "rows" + type: "array" + description: "" + subattributes: + - name: "id" + type: "string" + description: "" + - name: "position" + type: "integer" + description: "" + - name: "required" + type: "boolean" + description: "" + - name: "text" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "visible" + type: "boolean" + description: "" + - name: "display_options" + type: "object" + description: "" + subattributes: + - name: "show_display_number" + type: "boolean" + description: "" + - name: "family" + type: "string" + description: "" + - name: "forced_ranking" + type: "boolean" + description: "" + - name: "headings" + type: "array" + description: "" + subattributes: + - name: "description" + type: "string" + description: "" + - name: "heading" + type: "string" + description: "" + - name: "image" + type: "object" + description: "" + subattributes: + - name: "s3_key" + type: "string" + description: "" + - name: "url" + type: "string" + description: "" + - name: "random_assignment" + type: "object" + description: "" + subattributes: + - name: "description" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "percent" + type: "number" + description: "" + - name: "position" + type: "integer" + description: "" + - name: "variable_name" + type: "string" + description: "" + - name: "href" + type: "string" + description: "" + - name: "id" + type: "string" + description: "" + - name: "nickname" + type: "string" + description: "" + - name: "position" + type: "integer" + description: "" + - name: "quiz_options" + type: "object" + description: "" + subattributes: + - name: "feedback" + type: "object" + description: "" + subattributes: + - name: "correct_text" + type: "string" + description: "" + - name: "incorrect_text" + type: "string" + description: "" + - name: "partial_text" + type: "string" + description: "" + - name: "scoring_enabled" + type: "boolean" + description: "" + - name: "required" + type: "object" + description: "" + subattributes: + - name: "amount" + type: "string" + description: "" + - name: "text" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "sorting" + type: "object" + description: "" + subattributes: + - name: "ignore_last" + type: "boolean" + description: "" + - name: "type" + type: "string" + description: "" + - name: "subtype" + type: "string" + description: "" + - name: "validation" + type: "object" + description: "" + subattributes: + - name: "max" + type: "string" + description: "" + - name: "min" + type: "string" + description: "" + - name: "sum" + type: "integer" + description: "" + - name: "sum_text" + type: "string" + description: "" + - name: "text" + type: "string" + description: "" + - name: "type" + type: "string" + description: "" + - name: "visible" + type: "boolean" + description: "" + - name: "title" + type: "string" + description: "" + + - name: "preview" + type: "string" + description: "The survey **Preview** URL." + + - name: "question_count" + type: "integer" + description: "Number of questions in survey." + + - name: "quiz_options" + type: "object" + description: "An object describing the quiz settings, if this survey is a quiz." + subattributes: + - name: "feedback" + type: "object" + description: "Text to show the user when they complete the quiz." + subattributes: + - name: "ranges" + type: "array" + description: "The ranges at which to show users certain feedback." + subattributes: + - name: "max" + type: "string" + description: "Maximum score for this feedback." + - name: "message" + type: "string" + description: "Feedback message." + - name: "min" + type: "string" + description: "Minimum score for this feedback." + - name: "ranges_type" + type: "string" + description: | + The type of parameters used: `percentage` or `points`. + - name: "is_quiz_mode" + type: "boolean" + description: "The on/off toggle for setting this survey as a quiz." + - name: "show_results_type" + type: "string" + description: | + What to reveal to the user when they complete the quiz: `disabled`, `results_only` or `results_and_answers`." + + - name: "response_count" + type: "integer" + description: "The number of responses survey has received." + + - name: "summary_url" + type: "string" + description: "The survey's **Summary** URL." + + - name: "title" + type: "string" + description: "The survey title." +--- diff --git a/_integration-schemas/surveymonkey/v2/surveys.md b/_integration-schemas/surveymonkey/v2/surveys.md new file mode 100644 index 000000000..d20e372a2 --- /dev/null +++ b/_integration-schemas/surveymonkey/v2/surveys.md @@ -0,0 +1,47 @@ +--- +tap: "surveymonkey" +version: "2" +key: "surveys" + +name: "surveys" +doc-link: "https://developer.surveymonkey.com/api/v3/" +singer-schema: https://github.com/singer-io/tap-surveymonkey/tree/TDL-23990-changes/tap_surveymonkey/schemas/surveys.json +description: "This table contains information about your surveys." + +replication-method: "Key-based Incremental" + +attributes: + - name: "date_created" + type: "date-time" + description: "" + + - name: "date_modified" + type: "date-time" + description: "" + replication-key: true + + - name: "id" + type: "string" + description: "" + primary-key: true + + - name: "language" + type: "string" + description: "" + + - name: "nickname" + type: "string" + description: "" + + - name: "question_count" + type: "integer" + description: "" + + - name: "response_count" + type: "integer" + description: "" + + - name: "title" + type: "string" + description: "" +--- \ No newline at end of file diff --git a/_saas-integrations/surveymonkey/v1/surveymonkey-v1.md b/_saas-integrations/surveymonkey/v1/surveymonkey-v1.md index 63be3a5e8..a79a4d699 100644 --- a/_saas-integrations/surveymonkey/v1/surveymonkey-v1.md +++ b/_saas-integrations/surveymonkey/v1/surveymonkey-v1.md @@ -13,10 +13,10 @@ # -------------------------- # title: SurveyMonkey (v1) -permalink: /integrations/saas/surveymonkey +permalink: /integrations/saas/surveymonkey/v1 keywords: surveymonkey, integration, schema, etl surveymonkey, surveymonkey etl, surveymonkey schema layout: singer -# input: false +input: false key: "surveymonkey-setup" diff --git a/_saas-integrations/surveymonkey/v2/surveymonkey-v2.md b/_saas-integrations/surveymonkey/v2/surveymonkey-v2.md new file mode 100644 index 000000000..2a2fbecff --- /dev/null +++ b/_saas-integrations/surveymonkey/v2/surveymonkey-v2.md @@ -0,0 +1,147 @@ +--- +# -------------------------- # +# USING THIS TEMPLATE # +# -------------------------- # + +## NEED HELP USING THIS TEMPLATE? SEE: +## https://docs-about-stitch-docs.netlify.com/reference/integration-templates/saas/ +## FOR INSTRUCTIONS & REFERENCE INFO + + +# -------------------------- # +# Page & Formatting # +# -------------------------- # + +title: SurveyMonkey (v2) +permalink: /integrations/saas/surveymonkey +keywords: surveymonkey, integration, schema, etl surveymonkey, surveymonkey etl, surveymonkey schema +layout: singer +# input: false + +key: "surveymonkey-setup" + + +# -------------------------- # +# Tap Details # +# -------------------------- # + +name: "surveymonkey" +display_name: "SurveyMonkey" + +singer: true +status-url: "https://developer.surveymonkey.com/tools/api_status/" + +tap-name: "SurveyMonkey" +repo-url: https://github.com/singer-io/tap-surveymonkey + +this-version: "2" + +api: | + [{{ integration.display_name }} REST API v3](https://developer.surveymonkey.com/api/v3/){:target="new"} + + +# -------------------------- # +# Stitch Details # +# -------------------------- # + +certified: false + +api-type: "platform.surveymonkey" + +historical: "1 year" +frequency: "1 hour" +tier: "Standard" + +anchor-scheduling: true +cron-scheduling: true + +extraction-logs: true +loading-reports: true + +table-selection: true +column-selection: true + +# attribution-window: "# days" +# attribution-is-configurable: + +# setup-name: "" + + +# -------------------------- # +# Feature Summary # +# -------------------------- # + +feature-summary: | + Stitch's {{ integration.display_name }} integration replicates data using the {{ integration.api | flatify | strip }}. Refer to the [Schema](#schema) section for a list of objects available for replication. + + +# -------------------------- # +# Incompatibilities # +# -------------------------- # + +## uncomment section below if integration is compatible with any Stitch destinations +## if incompatible with multiple destinations, create a section for each destination + +## incompatible: + ## [redshift]: "always,sometimes,never" + ## reason: "copy" + +# -------------------------- # +# Setup Instructions # +# -------------------------- # + +requirements-list: + - item: | + **An Enterprise {{ integration.display_name }} account.** This is required to complete the setup in {{ integration.display_name }}. + +setup-steps: + - title: "Retrieve your access token and Survey ID" + anchor: "retrieve-access-token-and-survey-id" + content: | + {% capture paid-account-content %} + **Note**: An Enterprise {{ integration.display_name }} account is required to complete this step. + {% endcapture %} + + {% include note.html type="single-line" content=paid-account-content %} + + 1. Login to your {{ integration.display_name }} and go to [App Directory](https://www.surveymonkey.com/apps){:target="new"}. + 2. Type `stitchdata` in the search input box to find the Stitchdata ETL app. + 3. Click the **Visit Site** button on the right side of the page. + 4. Click the **Authorize** button. + 5. The access token and list of surveys are shown after authorization: + + ![Access token and the list of Survey IDs.]({{ site.baseurl }}/images/integrations/surveymonkey-access-token.png){:style="max-width: 450px;"} + + Leave this page open - you'll need it in the next step. **Note**: You may come back at any time to retrieve your access token or identify a new survey ID. + + - title: "Add {{ integration.display_name }} as a Stitch data source" + anchor: "add-stitch-data-source" + content: | + {% include integrations/shared-setup/connection-setup.html %} + 4. In the **Access Token** field, add your access token that you obtained in [Step 1](#retrieve-access-token-and-survey-id). + 5. In the **Survey Id** field, add your survey ID that you retrieved in [Step 1](#retrieve-access-token-and-survey-id). + - title: "Define the historical replication start date" + anchor: "define-historical-sync" + content: | + {% include integrations/saas/setup/historical-sync.html %} + + - title: "Create a replication schedule" + anchor: "define-rep-frequency" + content: | + {% include integrations/shared-setup/replication-frequency.html %} + + - title: "Set objects to replicate" + anchor: "setting-data-to-replicate" + content: | + {% include integrations/shared-setup/data-selection/object-selection.html %} + + +# -------------------------- # +# Integration Tables # +# -------------------------- # + +# Looking for the table schemas & info? +# Each table has a its own .md file in /_integration-schemas/surveymonkey/v1 +--- +{% assign integration = page %} +{% include misc/data-files.html %}