diff --git a/spec/marketing.json b/spec/marketing.json index 139546f..361d2ff 100644 --- a/spec/marketing.json +++ b/spec/marketing.json @@ -84434,185 +84434,6 @@ } ], "responses": { - "200": { - "description": "Landing Page Published", - "schema": { - "type": "object", - "title": "Landing Page", - "description": "A summary of an individual landing page's settings and content.", - "properties": { - "id": { - "type": "string", - "title": "Landing Page ID", - "description": "A string that uniquely identifies this landing page.", - "readOnly": true, - "example": "030092c2e1f0" - }, - "name": { - "type": "string", - "title": "Landing Page Name", - "description": "The name of this landing page.", - "readOnly": false - }, - "title": { - "type": "string", - "title": "Landing Page title", - "description": "The title of this landing page seen in the browser's title bar.", - "readOnly": false - }, - "description": { - "type": "string", - "title": "Landing Page description", - "description": "The description of this landing page.", - "readOnly": false - }, - "template_id": { - "type": "integer", - "title": "Landing Page template_id", - "description": "The template_id of this landing page.", - "readOnly": true - }, - "status": { - "type": "string", - "title": "Landing Page status", - "description": "The status of this landing page.", - "enum": [ - "published", - "unpublished", - "draft" - ], - "readOnly": true - }, - "list_id": { - "type": "string", - "title": "Landing Page list id", - "description": "The list's ID associated with this landing page.", - "example": "fde02ad86b", - "readOnly": false - }, - "store_id": { - "type": "string", - "title": "Store ID", - "description": "The ID of the store associated with this landing page.", - "readOnly": false - }, - "web_id": { - "type": "integer", - "title": "Landing Page Web ID", - "description": "The ID used in the Mailchimp web application." - }, - "created_by_source": { - "type": "string", - "title": "Created By Source", - "description": "Created by mobile or web", - "readOnly": true - }, - "url": { - "type": "string", - "title": "Published url", - "description": "The url of the published landing page.", - "readOnly": true - }, - "created_at": { - "type": "string", - "title": "Created At", - "description": "The time this landing page was created.", - "format": "date-time", - "readOnly": true - }, - "published_at": { - "type": "string", - "title": "Published at", - "description": "The time this landing page was published.", - "format": "date-time", - "readOnly": true - }, - "unpublished_at": { - "type": "string", - "title": "Unpublished at", - "description": "The time this landing page was unpublished.", - "format": "date-time", - "readOnly": true - }, - "updated_at": { - "type": "string", - "title": "Updated_at", - "description": "The time this landing page was updated at.", - "format": "date-time", - "readOnly": true - }, - "tracking": { - "type": "object", - "title": "Tracking Settings", - "description": "The tracking settings applied to this landing page.", - "properties": { - "track_with_mailchimp": { - "type": "boolean", - "title": "Track with Mailchimp", - "description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)." - }, - "enable_restricted_data_processing": { - "type": "boolean", - "title": "Enable restricted data processing", - "description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)." - } - } - }, - "_links": { - "title": "Links", - "description": "A list of link types and descriptions for the API schema documents.", - "type": "array", - "items": { - "type": "object", - "title": "Resource Link", - "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", - "properties": { - "rel": { - "type": "string", - "title": "Rel", - "description": "As with an HTML 'rel' attribute, this describes the type of link.", - "readOnly": true - }, - "href": { - "type": "string", - "title": "Href", - "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", - "readOnly": true - }, - "method": { - "type": "string", - "title": "Method", - "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", - "enum": [ - "GET", - "POST", - "PUT", - "PATCH", - "DELETE", - "OPTIONS", - "HEAD" - ], - "readOnly": true - }, - "targetSchema": { - "type": "string", - "title": "Target Schema", - "description": "For GETs, this is a URL representing the schema that the response should conform to.", - "readOnly": true - }, - "schema": { - "type": "string", - "title": "Schema", - "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", - "readOnly": true - } - } - }, - "readOnly": true - } - } - } - }, "204": { "description": "Empty Response" }, @@ -130772,7 +130593,195 @@ "questions": { "type": "array", "title": "Question Reports", - "description": "An array of reports for each question on the survey." + "description": "An array of reports for each question on the survey.", + "items": { + "type": "object", + "title": "Survey Question Report", + "description": "The details of a survey question's report.", + "properties": { + "id": { + "type": "string", + "title": "Survey Question ID", + "description": "The ID of the survey question.", + "readOnly": true + }, + "survey_id": { + "type": "string", + "title": "Survey ID", + "description": "The unique ID of the survey.", + "readOnly": true + }, + "query": { + "type": "string", + "title": "Query Text", + "description": "The query of the survey question.", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Response Type", + "description": "The response type of the survey question.", + "enum": [ + "pickOne", + "pickMany", + "range", + "text", + "email" + ], + "readOnly": true + }, + "total_responses": { + "type": "integer", + "title": "Total Responses", + "description": "The total number of responses to this question.", + "readOnly": true, + "example": 810 + }, + "is_required": { + "type": "boolean", + "title": "Is Required", + "description": "Whether this survey question is required to answer.", + "readOnly": true + }, + "has_other": { + "type": "boolean", + "title": "Has Other Option", + "description": "Whether this survey question has an 'other' option.", + "readOnly": true + }, + "other_label": { + "type": "string", + "title": "Other Option Label", + "description": "Label used for the 'other' option of this survey question.", + "readOnly": true + }, + "average_rating": { + "type": "number", + "format": "float", + "title": "Average Rating for a Range Question", + "description": "The average rating for this range question.", + "readOnly": true, + "example": 2.5 + }, + "range_low_label": { + "type": "string", + "title": "Range Low Label", + "description": "Label for the low end of the range.", + "readOnly": true + }, + "range_high_label": { + "type": "string", + "title": "Range High Label", + "description": "Label for the high end of the range.", + "readOnly": true + }, + "placeholder_label": { + "type": "string", + "title": "Placeholder Label", + "description": "Placeholder text for this survey question's answer box.", + "readOnly": true + }, + "subscribe_checkbox_enabled": { + "type": "boolean", + "title": "Is Subscribe Checkbox Enabled", + "description": "Whether the subscribe checkbox is shown for this email question.", + "readOnly": true + }, + "subscribe_checkbox_label": { + "type": "string", + "title": "Subscribe Checkbox Label", + "description": "Label used for the subscribe checkbox for this email question.", + "readOnly": true + }, + "merge_field": { + "type": "object", + "title": "Merge Field", + "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", + "properties": { + "id": { + "type": "integer", + "title": "Merge Field ID", + "description": "An unchanging id for the merge field.", + "readOnly": true + }, + "label": { + "type": "string", + "title": "Merge Field Label", + "description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Merge Field Type", + "description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", + "enum": [ + "text", + "number", + "address", + "phone", + "date", + "url", + "imageurl", + "radio", + "dropdown", + "birthday", + "zip" + ], + "readOnly": true + } + }, + "readOnly": true + }, + "options": { + "type": "array", + "title": "Options", + "description": "The answer choices for this question.", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "title": "Option Label", + "description": "The label for this survey question option." + }, + "id": { + "type": "string", + "title": "Option ID", + "description": "The ID for this survey question option." + }, + "count": { + "type": "integer", + "title": "Response Count", + "description": "The count of responses that selected this survey question option." + } + } + }, + "readOnly": true + }, + "contact_counts": { + "type": "object", + "title": "Contact Counts", + "description": "For email question types, how many are new, known, or unknown contacts.", + "properties": { + "known": { + "type": "integer", + "title": "Known Contacts Count", + "description": "The number of known contacts that responded to this survey." + }, + "unknown": { + "type": "integer", + "title": "Unknown Contacts Count", + "description": "The number of unknown contacts that responded to this survey." + }, + "new": { + "type": "integer", + "title": "New Contacts Count", + "description": "The number of new contacts that responded to this survey." + } + } + } + } + } }, "total_items": { "type": "integer", @@ -130941,7 +130950,195 @@ ], "responses": { "200": { - "description": "Survey Question Report Instance" + "description": "Survey Question Report Instance", + "schema": { + "type": "object", + "title": "Survey Question Report", + "description": "The details of a survey question's report.", + "properties": { + "id": { + "type": "string", + "title": "Survey Question ID", + "description": "The ID of the survey question.", + "readOnly": true + }, + "survey_id": { + "type": "string", + "title": "Survey ID", + "description": "The unique ID of the survey.", + "readOnly": true + }, + "query": { + "type": "string", + "title": "Query Text", + "description": "The query of the survey question.", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Response Type", + "description": "The response type of the survey question.", + "enum": [ + "pickOne", + "pickMany", + "range", + "text", + "email" + ], + "readOnly": true + }, + "total_responses": { + "type": "integer", + "title": "Total Responses", + "description": "The total number of responses to this question.", + "readOnly": true, + "example": 810 + }, + "is_required": { + "type": "boolean", + "title": "Is Required", + "description": "Whether this survey question is required to answer.", + "readOnly": true + }, + "has_other": { + "type": "boolean", + "title": "Has Other Option", + "description": "Whether this survey question has an 'other' option.", + "readOnly": true + }, + "other_label": { + "type": "string", + "title": "Other Option Label", + "description": "Label used for the 'other' option of this survey question.", + "readOnly": true + }, + "average_rating": { + "type": "number", + "format": "float", + "title": "Average Rating for a Range Question", + "description": "The average rating for this range question.", + "readOnly": true, + "example": 2.5 + }, + "range_low_label": { + "type": "string", + "title": "Range Low Label", + "description": "Label for the low end of the range.", + "readOnly": true + }, + "range_high_label": { + "type": "string", + "title": "Range High Label", + "description": "Label for the high end of the range.", + "readOnly": true + }, + "placeholder_label": { + "type": "string", + "title": "Placeholder Label", + "description": "Placeholder text for this survey question's answer box.", + "readOnly": true + }, + "subscribe_checkbox_enabled": { + "type": "boolean", + "title": "Is Subscribe Checkbox Enabled", + "description": "Whether the subscribe checkbox is shown for this email question.", + "readOnly": true + }, + "subscribe_checkbox_label": { + "type": "string", + "title": "Subscribe Checkbox Label", + "description": "Label used for the subscribe checkbox for this email question.", + "readOnly": true + }, + "merge_field": { + "type": "object", + "title": "Merge Field", + "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", + "properties": { + "id": { + "type": "integer", + "title": "Merge Field ID", + "description": "An unchanging id for the merge field.", + "readOnly": true + }, + "label": { + "type": "string", + "title": "Merge Field Label", + "description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", + "readOnly": true + }, + "type": { + "type": "string", + "title": "Merge Field Type", + "description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", + "enum": [ + "text", + "number", + "address", + "phone", + "date", + "url", + "imageurl", + "radio", + "dropdown", + "birthday", + "zip" + ], + "readOnly": true + } + }, + "readOnly": true + }, + "options": { + "type": "array", + "title": "Options", + "description": "The answer choices for this question.", + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "title": "Option Label", + "description": "The label for this survey question option." + }, + "id": { + "type": "string", + "title": "Option ID", + "description": "The ID for this survey question option." + }, + "count": { + "type": "integer", + "title": "Response Count", + "description": "The count of responses that selected this survey question option." + } + } + }, + "readOnly": true + }, + "contact_counts": { + "type": "object", + "title": "Contact Counts", + "description": "For email question types, how many are new, known, or unknown contacts.", + "properties": { + "known": { + "type": "integer", + "title": "Known Contacts Count", + "description": "The number of known contacts that responded to this survey." + }, + "unknown": { + "type": "integer", + "title": "Unknown Contacts Count", + "description": "The number of unknown contacts that responded to this survey." + }, + "new": { + "type": "integer", + "title": "New Contacts Count", + "description": "The number of new contacts that responded to this survey." + } + } + } + } + } }, "default": { "description": "An error generated by the Mailchimp API.", @@ -131030,25 +131227,6 @@ "type": "string" } }, - { - "name": "count", - "x-title": "Count", - "in": "query", - "description": "The number of records to return. Default value is 10. Maximum value is 1000", - "required": false, - "default": 10, - "maximum": 1000, - "type": "integer" - }, - { - "name": "offset", - "x-title": "Offset", - "in": "query", - "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", - "required": false, - "default": 0, - "type": "integer" - }, { "in": "path", "name": "outreach_id", @@ -131064,6 +131242,19 @@ "type": "string", "required": true, "description": "The ID of the survey question." + }, + { + "name": "respondent_familiarity_is", + "x-title": "Respondent Familiarity Is", + "in": "query", + "description": "Filter survey responses by familiarity of the respondents.", + "required": false, + "type": "string", + "enum": [ + "new", + "known", + "unknown" + ] } ], "responses": { @@ -131075,7 +131266,102 @@ "answers": { "type": "array", "title": "Answers", - "description": "An array of answers for a question on the survey." + "description": "An array of answers for a question on the survey.", + "items": { + "type": "object", + "title": "Survey Question Answer", + "description": "The details of a survey question's answer.", + "properties": { + "id": { + "type": "string", + "title": "Answer ID", + "description": "The ID of the answer.", + "readOnly": true + }, + "value": { + "type": "string", + "title": "Value", + "description": "The raw text answer.", + "readOnly": true + }, + "response_id": { + "type": "string", + "title": "Response ID", + "description": "The ID of the survey response.", + "readOnly": true + }, + "submitted_at": { + "type": "string", + "format": "date-time", + "title": "Submitted At", + "description": "The date and time when the survey response was submitted in ISO 8601 format.", + "readOnly": true + }, + "contact": { + "type": "object", + "title": "Contact", + "description": "Information about the contact.", + "readOnly": true, + "properties": { + "email_id": { + "type": "string", + "title": "Email ID", + "description": "The MD5 hash of the lowercase version of the list member's email address.", + "readOnly": true + }, + "contact_id": { + "type": "string", + "title": "Contact ID", + "description": "The ID of this contact.", + "readOnly": true + }, + "status": { + "type": "string", + "title": "Contact Status", + "description": "The contact's current status.", + "readOnly": true, + "enum": [ + "Subscribed", + "Unsubscribed", + "Non-Subscribed", + "Cleaned", + "Archived" + ] + }, + "email": { + "type": "string", + "title": "Contact Email", + "description": "The contact's email address.", + "readOnly": true + }, + "full_name": { + "type": "string", + "title": "Full Name", + "description": "The contact's full name.", + "readOnly": true + }, + "consents_to_one_to_one_messaging": { + "type": "boolean", + "title": "Messaging Consent", + "description": "Indicates whether a contact consents to 1:1 messaging.", + "readOnly": true + }, + "avatar_url": { + "type": "string", + "title": "Avatar URL", + "description": "URL for the contact's avatar or profile image.", + "readOnly": true + } + } + }, + "is_new_contact": { + "type": "boolean", + "title": "Is New Contact", + "description": "If this contact was added to the Mailchimp audience via this survey.", + "readOnly": false + } + } + } }, "total_items": { "type": "integer", @@ -131225,25 +131511,6 @@ "type": "string" } }, - { - "name": "count", - "x-title": "Count", - "in": "query", - "description": "The number of records to return. Default value is 10. Maximum value is 1000", - "required": false, - "default": 10, - "maximum": 1000, - "type": "integer" - }, - { - "name": "offset", - "x-title": "Offset", - "in": "query", - "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", - "required": false, - "default": 0, - "type": "integer" - }, { "in": "path", "name": "outreach_id", @@ -131267,6 +131534,19 @@ "description": "The ID of the option chosen to filter responses on.", "required": false, "type": "string" + }, + { + "name": "respondent_familiarity_is", + "x-title": "Respondent Familiarity Is", + "in": "query", + "description": "Filter survey responses by familiarity of the respondents.", + "required": false, + "type": "string", + "enum": [ + "new", + "known", + "unknown" + ] } ], "responses": {