ListsUpdateWebhookSettingsResponse
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsUpdateWebhookSettingsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ListsViewRecentActivity200Response
{
"type": "object",
"title": "Member Activity Events",
"x-hidden": false,
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Email Opens",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"open"
],
"type": "string",
"x-value": "open",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing opening an email."
},
{
"type": "object",
"title": "Email Clicks",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"link_clicked": {
"type": "string",
"title": "Link Clicked",
"description": "The URL of the link that was clicked."
},
"activity_type": {
"enum": [
"click"
],
"type": "string",
"x-value": "click",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having a link clicked by a contact."
},
{
"type": "object",
"title": "Email Bounced",
"properties": {
"bounce_type": {
"enum": [
"hard",
"soft"
],
"type": "string",
"title": "Bounce Type",
"description": "The type of bounce."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"bounce"
],
"type": "string",
"x-value": "bounce",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"bounce_has_open_activity": {
"type": "boolean",
"title": "Bounce Has Open Activity",
"description": "Indicates if the email associated with this bounce also has open activity on the same campaign."
}
},
"description": "Activity feed item representing an email to this contact bouncing."
},
{
"type": "object",
"title": "List Unsubscribed",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"unsub"
],
"type": "string",
"x-value": "unsub",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Text",
"description": "The title of the campaign."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "Indicates the reason that the contact was unsubscribed."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"is_admin_unsubscribed": {
"type": "boolean",
"title": "Is Admin Unsubscribed",
"description": "Indicates if an admin unsubscribed a contact."
}
},
"description": "Activity feed item representing this contact unsubscribing from a list."
},
{
"type": "object",
"title": "Email Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sent"
],
"type": "string",
"x-value": "sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having an email sent to the contact."
},
{
"type": "object",
"title": "Email Conversation",
"properties": {
"is_user": {
"type": "boolean",
"title": "Is User",
"description": "Indicates that the message created by a user (as opposed to a contact)."
},
"has_read": {
"type": "boolean",
"title": "Has Read",
"description": "Indicates that the message has been read."
},
"thread_id": {
"type": "string",
"title": "Thread ID",
"description": "The thread's unique id of the conversation referenced in this event."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The gravatar URL of the contact who sent the reply."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The username of the person who created this event."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "The email of the contact who sent the reply."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"message_text": {
"type": "string",
"title": "Message Text",
"description": "The body of the message in this conversation."
},
"activity_type": {
"enum": [
"conversation"
],
"type": "string",
"x-value": "conversation",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an individual reply in a conversation."
},
{
"type": "object",
"title": "Note",
"properties": {
"note_id": {
"type": "string",
"title": "Note ID",
"description": "The note's unique id."
},
"note_text": {
"type": "string",
"title": "Note Text",
"description": "The note's text."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The URL of the contact's profile gravatar image."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The person who created the note."
},
"activity_type": {
"enum": [
"note"
],
"type": "string",
"x-value": "note",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"updated_at_timestamp": {
"type": "string",
"title": "Updated At Timestamp",
"format": "date-time",
"description": "The updated at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a note on the contact record."
},
{
"type": "object",
"title": "Marketing Permission",
"properties": {
"updated_by": {
"type": "string",
"title": "Updated By",
"description": "The name of the contact who updated this permission."
},
"activity_type": {
"enum": [
"marketing_permission"
],
"type": "string",
"x-value": "marketing_permission",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"marketing_permisson_text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text describing this marketing permission."
},
"marketing_permission_opted_in": {
"type": "boolean",
"title": "Marketing Permission Opted In",
"description": "Indicates if the marketing permission is enabled or not."
}
},
"description": "Activity feed item indicating if a marketing permission was added or updated."
},
{
"type": "object",
"title": "Postcard Sent",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"postcard_sent"
],
"type": "string",
"x-value": "postcard_sent",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a time when a contact was sent a particular postcard."
},
{
"type": "object",
"title": "Squatter Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"squatter_signup"
],
"type": "string",
"x-value": "squatter_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the audience from a squatter page."
},
{
"type": "object",
"title": "Website Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"website_signup"
],
"type": "string",
"x-value": "website_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the contact through a website page."
},
{
"type": "object",
"title": "Landing Page Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"landing_page_signup"
],
"type": "string",
"x-value": "landing_page_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a landing page."
},
{
"type": "object",
"title": "Ecommerce Signup",
"properties": {
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store."
},
"activity_type": {
"enum": [
"ecommerce_signup"
],
"type": "string",
"x-value": "ecommerce_signup",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a ecommerce store."
},
{
"type": "object",
"title": "Generic Signup",
"properties": {
"activity_type": {
"enum": [
"generic_signup"
],
"type": "string",
"x-value": "generic_signup",
"description": "The type of event activity."
},
"signup_category": {
"type": "string",
"title": "Signup Category",
"description": "How was this user added to the list."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to)."
},
{
"type": "object",
"title": "Ecommerce Order",
"properties": {
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The unique order id."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The order URL."
},
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store for an order."
},
"order_items": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Items",
"description": "An array of items that have been ordered."
},
"order_total": {
"type": "string",
"title": "Order Total",
"description": "The order total formatted as a string."
},
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"order"
],
"type": "string",
"x-value": "order",
"description": "The type of event activity."
},
"outreach_type": {
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach that triggered the event."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"type": "string",
"title": "Integration Platform",
"description": "The name of the integration platform this order originated through."
}
},
"description": "Activity feed item that represents an order."
},
{
"type": "object",
"title": "Contact Activity Event",
"properties": {
"event_name": {
"type": "string",
"title": "Event Name",
"description": "The name of the event."
},
"activity_type": {
"enum": [
"event"
],
"type": "string",
"x-value": "event",
"description": "The type of event activity."
},
"event_properties": {
"type": "array",
"items": {
"type": "string",
"x-skip-validation": true
},
"title": "Event Properties",
"description": "An arbitrary datastore containing properties for the given event."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a generic event."
},
{
"type": "object",
"title": "Survey response",
"properties": {
"survey_id": {
"type": "string",
"title": "Survey ID",
"description": "The survey's unique id."
},
"survey_title": {
"type": "string",
"title": "Survey Title",
"description": "The title of the survey."
},
"activity_type": {
"enum": [
"survey_response"
],
"type": "string",
"x-value": "survey_response",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Represents when a contact completes and submits a survey"
},
{
"type": "object",
"title": "SMS Bulk Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sms_bulk_sent"
],
"type": "string",
"x-value": "sms_bulk_sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the SMS campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an SMS campaign sent to the contact."
},
{
"type": "object",
"title": "Inbox Thread",
"properties": {
"id": {
"type": "string",
"title": "Thread ID",
"description": "The ID of the thread."
},
"thread_url": {
"type": "string",
"title": "Thread URL",
"description": "The url of the thread."
},
"activity_type": {
"enum": [
"inbox_thread"
],
"type": "string",
"x-value": "inbox_thread",
"description": "The type of event activity."
},
"thread_author": {
"type": "string",
"title": "Thread Author",
"description": "The author of the thread."
},
"thread_subject": {
"type": "string",
"title": "Thread Subject",
"description": "The subject of the thread."
},
"thread_direction": {
"enum": [
"INBOUND",
"OUTBOUND"
],
"type": "string",
"title": "Thread Direction",
"description": "The direction of the message noting if it is outbound or inbound."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a thread located in Inbox."
},
{
"type": "object",
"title": "QBO Payment Link",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The QuickBooks payment link id."
},
"activity_type": {
"enum": [
"qbo_payment_link"
],
"type": "string",
"x-value": "qbo_payment_link",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"enum": [
"quickbooks"
],
"type": "string",
"title": "Integration Platform",
"description": "The platform Mailchimp is integrated with."
},
"qbo_payment_external_id": {
"type": "string",
"title": "QBO Payment External ID",
"description": "The external QuickBooks payment id."
}
},
"description": "Activity feed item representing a payment link from QBO."
},
{
"type": "object",
"title": "Video Call Transcripts",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id for video call transcripts."
},
"activity_type": {
"enum": [
"video_call_transcripts"
],
"type": "string",
"x-value": "video_call_transcripts",
"description": "The type of event activity."
},
"expire_at_timestamp": {
"type": "string",
"title": "Expire At Timestamp",
"format": "date-time",
"description": "The Expire At timestamp in ISO8601."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"scheduled_meeting_start_timestamp": {
"type": "string",
"title": "Scheduled Meeting Start Timestamp",
"format": "date-time",
"description": "The Scheduled Meeting Start timestamp in ISO8601."
}
},
"description": "Activity feed item representing a video call transcript."
}
],
"discriminator": {
"type": "string",
"propertyName": "activity_type"
}
},
"title": "Activity",
"readOnly": true,
"description": "An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas)."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"description": "The member activity events for a given member."
}
ListsViewRecentActivityEvents200Response
{
"type": "object",
"title": "Member Activity Events",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "For clicks, the URL the subscriber clicked on."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign that was sent."
},
"title": {
"type": "string",
"title": "Campaign Title",
"description": "If set, the campaign's title."
},
"action": {
"type": "string",
"title": "Action Type",
"description": "The type of action recorded for the subscriber."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The web-based ID for the campaign."
},
"parent_campaign": {
"type": "string",
"title": "Parent Campaign ID",
"description": "The ID of the parent campaign."
}
},
"description": "Member activity events."
},
"title": "Activity",
"description": "An array of objects, each representing a member event."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 member events for a list."
}
ListsViewRecentActivityEventsResponse
{
"type": "object",
"title": "Member Activity Events",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "For clicks, the URL the subscriber clicked on."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign that was sent."
},
"title": {
"type": "string",
"title": "Campaign Title",
"description": "If set, the campaign's title."
},
"action": {
"type": "string",
"title": "Action Type",
"description": "The type of action recorded for the subscriber."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The web-based ID for the campaign."
},
"parent_campaign": {
"type": "string",
"title": "Parent Campaign ID",
"description": "The ID of the parent campaign."
}
},
"description": "Member activity events."
},
"title": "Activity",
"description": "An array of objects, each representing a member event."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 member events for a list."
}
ListsViewRecentActivityEventsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ListsViewRecentActivityResponse
{
"type": "object",
"title": "Member Activity Events",
"x-hidden": false,
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Email Opens",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"open"
],
"type": "string",
"x-value": "open",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing opening an email."
},
{
"type": "object",
"title": "Email Clicks",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"link_clicked": {
"type": "string",
"title": "Link Clicked",
"description": "The URL of the link that was clicked."
},
"activity_type": {
"enum": [
"click"
],
"type": "string",
"x-value": "click",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having a link clicked by a contact."
},
{
"type": "object",
"title": "Email Bounced",
"properties": {
"bounce_type": {
"enum": [
"hard",
"soft"
],
"type": "string",
"title": "Bounce Type",
"description": "The type of bounce."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"bounce"
],
"type": "string",
"x-value": "bounce",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"bounce_has_open_activity": {
"type": "boolean",
"title": "Bounce Has Open Activity",
"description": "Indicates if the email associated with this bounce also has open activity on the same campaign."
}
},
"description": "Activity feed item representing an email to this contact bouncing."
},
{
"type": "object",
"title": "List Unsubscribed",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"unsub"
],
"type": "string",
"x-value": "unsub",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Text",
"description": "The title of the campaign."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "Indicates the reason that the contact was unsubscribed."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"is_admin_unsubscribed": {
"type": "boolean",
"title": "Is Admin Unsubscribed",
"description": "Indicates if an admin unsubscribed a contact."
}
},
"description": "Activity feed item representing this contact unsubscribing from a list."
},
{
"type": "object",
"title": "Email Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sent"
],
"type": "string",
"x-value": "sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having an email sent to the contact."
},
{
"type": "object",
"title": "Email Conversation",
"properties": {
"is_user": {
"type": "boolean",
"title": "Is User",
"description": "Indicates that the message created by a user (as opposed to a contact)."
},
"has_read": {
"type": "boolean",
"title": "Has Read",
"description": "Indicates that the message has been read."
},
"thread_id": {
"type": "string",
"title": "Thread ID",
"description": "The thread's unique id of the conversation referenced in this event."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The gravatar URL of the contact who sent the reply."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The username of the person who created this event."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "The email of the contact who sent the reply."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"message_text": {
"type": "string",
"title": "Message Text",
"description": "The body of the message in this conversation."
},
"activity_type": {
"enum": [
"conversation"
],
"type": "string",
"x-value": "conversation",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an individual reply in a conversation."
},
{
"type": "object",
"title": "Note",
"properties": {
"note_id": {
"type": "string",
"title": "Note ID",
"description": "The note's unique id."
},
"note_text": {
"type": "string",
"title": "Note Text",
"description": "The note's text."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The URL of the contact's profile gravatar image."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The person who created the note."
},
"activity_type": {
"enum": [
"note"
],
"type": "string",
"x-value": "note",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"updated_at_timestamp": {
"type": "string",
"title": "Updated At Timestamp",
"format": "date-time",
"description": "The updated at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a note on the contact record."
},
{
"type": "object",
"title": "Marketing Permission",
"properties": {
"updated_by": {
"type": "string",
"title": "Updated By",
"description": "The name of the contact who updated this permission."
},
"activity_type": {
"enum": [
"marketing_permission"
],
"type": "string",
"x-value": "marketing_permission",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"marketing_permisson_text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text describing this marketing permission."
},
"marketing_permission_opted_in": {
"type": "boolean",
"title": "Marketing Permission Opted In",
"description": "Indicates if the marketing permission is enabled or not."
}
},
"description": "Activity feed item indicating if a marketing permission was added or updated."
},
{
"type": "object",
"title": "Postcard Sent",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"postcard_sent"
],
"type": "string",
"x-value": "postcard_sent",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a time when a contact was sent a particular postcard."
},
{
"type": "object",
"title": "Squatter Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"squatter_signup"
],
"type": "string",
"x-value": "squatter_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the audience from a squatter page."
},
{
"type": "object",
"title": "Website Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"website_signup"
],
"type": "string",
"x-value": "website_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the contact through a website page."
},
{
"type": "object",
"title": "Landing Page Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"landing_page_signup"
],
"type": "string",
"x-value": "landing_page_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a landing page."
},
{
"type": "object",
"title": "Ecommerce Signup",
"properties": {
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store."
},
"activity_type": {
"enum": [
"ecommerce_signup"
],
"type": "string",
"x-value": "ecommerce_signup",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a ecommerce store."
},
{
"type": "object",
"title": "Generic Signup",
"properties": {
"activity_type": {
"enum": [
"generic_signup"
],
"type": "string",
"x-value": "generic_signup",
"description": "The type of event activity."
},
"signup_category": {
"type": "string",
"title": "Signup Category",
"description": "How was this user added to the list."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to)."
},
{
"type": "object",
"title": "Ecommerce Order",
"properties": {
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The unique order id."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The order URL."
},
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store for an order."
},
"order_items": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Items",
"description": "An array of items that have been ordered."
},
"order_total": {
"type": "string",
"title": "Order Total",
"description": "The order total formatted as a string."
},
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"order"
],
"type": "string",
"x-value": "order",
"description": "The type of event activity."
},
"outreach_type": {
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach that triggered the event."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"type": "string",
"title": "Integration Platform",
"description": "The name of the integration platform this order originated through."
}
},
"description": "Activity feed item that represents an order."
},
{
"type": "object",
"title": "Contact Activity Event",
"properties": {
"event_name": {
"type": "string",
"title": "Event Name",
"description": "The name of the event."
},
"activity_type": {
"enum": [
"event"
],
"type": "string",
"x-value": "event",
"description": "The type of event activity."
},
"event_properties": {
"type": "array",
"items": {
"type": "string",
"x-skip-validation": true
},
"title": "Event Properties",
"description": "An arbitrary datastore containing properties for the given event."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a generic event."
},
{
"type": "object",
"title": "Survey response",
"properties": {
"survey_id": {
"type": "string",
"title": "Survey ID",
"description": "The survey's unique id."
},
"survey_title": {
"type": "string",
"title": "Survey Title",
"description": "The title of the survey."
},
"activity_type": {
"enum": [
"survey_response"
],
"type": "string",
"x-value": "survey_response",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Represents when a contact completes and submits a survey"
},
{
"type": "object",
"title": "SMS Bulk Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sms_bulk_sent"
],
"type": "string",
"x-value": "sms_bulk_sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the SMS campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an SMS campaign sent to the contact."
},
{
"type": "object",
"title": "Inbox Thread",
"properties": {
"id": {
"type": "string",
"title": "Thread ID",
"description": "The ID of the thread."
},
"thread_url": {
"type": "string",
"title": "Thread URL",
"description": "The url of the thread."
},
"activity_type": {
"enum": [
"inbox_thread"
],
"type": "string",
"x-value": "inbox_thread",
"description": "The type of event activity."
},
"thread_author": {
"type": "string",
"title": "Thread Author",
"description": "The author of the thread."
},
"thread_subject": {
"type": "string",
"title": "Thread Subject",
"description": "The subject of the thread."
},
"thread_direction": {
"enum": [
"INBOUND",
"OUTBOUND"
],
"type": "string",
"title": "Thread Direction",
"description": "The direction of the message noting if it is outbound or inbound."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a thread located in Inbox."
},
{
"type": "object",
"title": "QBO Payment Link",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The QuickBooks payment link id."
},
"activity_type": {
"enum": [
"qbo_payment_link"
],
"type": "string",
"x-value": "qbo_payment_link",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"enum": [
"quickbooks"
],
"type": "string",
"title": "Integration Platform",
"description": "The platform Mailchimp is integrated with."
},
"qbo_payment_external_id": {
"type": "string",
"title": "QBO Payment External ID",
"description": "The external QuickBooks payment id."
}
},
"description": "Activity feed item representing a payment link from QBO."
},
{
"type": "object",
"title": "Video Call Transcripts",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id for video call transcripts."
},
"activity_type": {
"enum": [
"video_call_transcripts"
],
"type": "string",
"x-value": "video_call_transcripts",
"description": "The type of event activity."
},
"expire_at_timestamp": {
"type": "string",
"title": "Expire At Timestamp",
"format": "date-time",
"description": "The Expire At timestamp in ISO8601."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"scheduled_meeting_start_timestamp": {
"type": "string",
"title": "Scheduled Meeting Start Timestamp",
"format": "date-time",
"description": "The Scheduled Meeting Start timestamp in ISO8601."
}
},
"description": "Activity feed item representing a video call transcript."
}
],
"discriminator": {
"type": "string",
"propertyName": "activity_type"
}
},
"title": "Activity",
"readOnly": true,
"description": "An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas)."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"description": "The member activity events for a given member."
}
ListsViewRecentActivitydefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
PingHealthCheck200Response
{
"type": "object",
"title": "API health status",
"properties": {
"health_status": {
"type": "string",
"title": "API health status",
"example": "\"Everything's Chimpy!\"",
"readOnly": true,
"description": "This will return a constant string value if the request is successful. Ex. \"Everything's Chimpy!\""
}
},
"description": "API health status."
}
PingHealthCheckResponse
{
"type": "object",
"title": "API health status",
"properties": {
"health_status": {
"type": "string",
"title": "API health status",
"example": "\"Everything's Chimpy!\"",
"readOnly": true,
"description": "This will return a constant string value if the request is successful. Ex. \"Everything's Chimpy!\""
}
},
"description": "API health status."
}
PingHealthCheckdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingFacebookAdReport200Response
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
}
}
]
}
ReportingFacebookAdReportResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
}
}
]
}
ReportingFacebookAdReportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingGetLandingPageReport200Response
{
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
ReportingGetLandingPageReportResponse
{
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
ReportingGetLandingPageReportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingGetSurveyReport200Response
{
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
}
ReportingGetSurveyReportResponse
{
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
}
ReportingGetSurveyReportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingListFacebookAdsReports200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
}
}
]
}
}
},
"description": "A collection of Facebook ads."
}
ReportingListFacebookAdsReportsResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
}
}
]
}
}
},
"description": "A collection of Facebook ads."
}
ReportingListFacebookAdsReportsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingListFacebookEcommerceReport200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportingListFacebookEcommerceReportResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportingListFacebookEcommerceReportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingListLandingPagesReports200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"landing_pages": {
"type": "array",
"items": {
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
}
},
"description": "A collection of landing pages."
}
ReportingListLandingPagesReportsResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"landing_pages": {
"type": "array",
"items": {
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
}
},
"description": "A collection of landing pages."
}
ReportingListLandingPagesReportsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingListSurveyQuestionsReports200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"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."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
},
"title": "Question Reports",
"description": "An array of reports for each question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyQuestionsReportsResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"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."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
},
"title": "Question Reports",
"description": "An array of reports for each question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyQuestionsReportsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingListSurveyReports200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"surveys": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
},
"title": "Surveys",
"description": "The surveys that have reports available."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyReportsResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"surveys": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
},
"title": "Surveys",
"description": "The surveys that have reports available."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyReportsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingSingleSurveyResponse200Response
{
"type": "object",
"title": "Survey Response",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"results": {
"type": "array",
"items": {
"type": "object",
"title": "Response",
"properties": {
"query": {
"type": "string",
"title": "Question Query",
"description": "The survey question."
},
"answer": {
"type": "string",
"title": "Answer",
"description": "The answer to this survey question."
},
"question_id": {
"type": "string",
"title": "Question ID",
"description": "The unique ID for this question."
},
"question_type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Question Type",
"description": "The type of question this is."
}
},
"description": "A single question and the response to that question."
},
"title": "Results",
"description": "The survey questions and the answers to those questions."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "A single survey response."
}
ReportingSingleSurveyResponseResponse
{
"type": "object",
"title": "Survey Response",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"results": {
"type": "array",
"items": {
"type": "object",
"title": "Response",
"properties": {
"query": {
"type": "string",
"title": "Question Query",
"description": "The survey question."
},
"answer": {
"type": "string",
"title": "Answer",
"description": "The answer to this survey question."
},
"question_id": {
"type": "string",
"title": "Question ID",
"description": "The unique ID for this question."
},
"question_type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Question Type",
"description": "The type of question this is."
}
},
"description": "A single question and the response to that question."
},
"title": "Results",
"description": "The survey questions and the answers to those questions."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "A single survey response."
}
ReportingSingleSurveyResponsedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingSurveyQuestionAnswersList200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Answer",
"properties": {
"id": {
"type": "string",
"title": "Answer ID",
"readOnly": true,
"description": "The ID of the answer."
},
"value": {
"type": "string",
"title": "Value",
"readOnly": true,
"description": "The raw text answer."
},
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID of the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "The details of a survey question's answer."
},
"title": "Answers",
"description": "An array of answers for a question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyQuestionAnswersListResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Answer",
"properties": {
"id": {
"type": "string",
"title": "Answer ID",
"readOnly": true,
"description": "The ID of the answer."
},
"value": {
"type": "string",
"title": "Value",
"readOnly": true,
"description": "The raw text answer."
},
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID of the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "The details of a survey question's answer."
},
"title": "Answers",
"description": "An array of answers for a question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyQuestionAnswersListdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingSurveyQuestionReport200Response
{
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"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."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
}
ReportingSurveyQuestionReportResponse
{
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"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."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
}
ReportingSurveyQuestionReportdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportingSurveyResponsesList200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"responses": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Respondents",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "Survey respondent details."
},
"title": "Responses",
"description": "An array of responses to a survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyResponsesListResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"responses": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Respondents",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "Survey respondent details."
},
"title": "Responses",
"description": "An array of responses to a survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyResponsesListdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
ReportsCampaignRecipientInfo200Response
{
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
}
ReportsCampaignRecipientInfoResponse
{
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
}
ReportsCampaignRecipientInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}