ReportsGetAbuseReport200Response
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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."
}
},
"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": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ReportsGetAbuseReportResponse
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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."
}
},
"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": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ReportsGetAbuseReportdefaultResponse
{
"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'."
}
ReportsGetCampaignClickDetails200Response
{
"type": "object",
"title": "Click Detail Report",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"urls_clicked": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
},
"title": "URLs Clicked",
"description": "An array of objects, each representing a specific URL contained in the campaign."
}
},
"description": "A list of URLs and unique IDs included in HTML and plain-text versions of a campaign."
}
ReportsGetCampaignClickDetailsResponse
{
"type": "object",
"title": "Click Detail Report",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"urls_clicked": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
},
"title": "URLs Clicked",
"description": "An array of objects, each representing a specific URL contained in the campaign."
}
},
"description": "A list of URLs and unique IDs included in HTML and plain-text versions of a campaign."
}
ReportsGetCampaignClickDetailsdefaultResponse
{
"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'."
}
ReportsGetCampaignProductActivity200Response
{
"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."
}
ReportsGetCampaignProductActivityResponse
{
"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."
}
ReportsGetCampaignProductActivitydefaultResponse
{
"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'."
}
ReportsGetSubscriberActivity200Response
{
"type": "object",
"title": "Email Activity",
"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 unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"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 list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
}
ReportsGetSubscriberActivityResponse
{
"type": "object",
"title": "Email Activity",
"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 unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"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 list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
}
ReportsGetSubscriberActivitydefaultResponse
{
"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'."
}
ReportsGetUnsubscribedMemberInfo200Response
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"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."
}
},
"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 member who unsubscribed from a specific campaign."
}
ReportsGetUnsubscribedMemberInfoResponse
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"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."
}
},
"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 member who unsubscribed from a specific campaign."
}
ReportsGetUnsubscribedMemberInfodefaultResponse
{
"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'."
}
ReportsListAbuseReports200Response
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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."
}
},
"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": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A list of abuse complaints for a specific list."
}
ReportsListAbuseReportsResponse
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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 unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"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."
}
},
"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": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A list of abuse complaints for a specific list."
}
ReportsListAbuseReportsdefaultResponse
{
"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'."
}
ReportsListCampaignFeedback200Response
{
"type": "object",
"title": "Campaign Advice Report",
"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."
},
"advice": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Advice",
"properties": {
"type": {
"enum": [
"negative",
"positive",
"neutral"
],
"type": "string",
"title": "Advice Type",
"readOnly": true,
"description": "The sentiment type for a feedback message."
},
"_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."
},
"message": {
"type": "string",
"title": "Advice Message",
"readOnly": true,
"description": "The advice message."
}
},
"description": "Campaign feedback details."
},
"title": "Campaign Advice",
"description": "An array of objects, each representing a point of campaign feedback."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of feedback based on a campaign's statistics."
}
ReportsListCampaignFeedbackResponse
{
"type": "object",
"title": "Campaign Advice Report",
"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."
},
"advice": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Advice",
"properties": {
"type": {
"enum": [
"negative",
"positive",
"neutral"
],
"type": "string",
"title": "Advice Type",
"readOnly": true,
"description": "The sentiment type for a feedback message."
},
"_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."
},
"message": {
"type": "string",
"title": "Advice Message",
"readOnly": true,
"description": "The advice message."
}
},
"description": "Campaign feedback details."
},
"title": "Campaign Advice",
"description": "An array of objects, each representing a point of campaign feedback."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of feedback based on a campaign's statistics."
}
ReportsListCampaignFeedbackdefaultResponse
{
"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'."
}
ReportsListCampaignOpenDetails200Response
{
"type": "object",
"title": "Open Detail Report",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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 unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"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."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"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 list of a member's opens activity in a specific campaign."
},
"title": "Open Reports",
"description": "An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_opens": {
"type": "integer",
"title": "Total opens",
"description": "The total number of opens matching the query regardless of pagination."
}
},
"description": "A detailed report of any campaign emails that were opened by a list member."
}
ReportsListCampaignOpenDetailsResponse
{
"type": "object",
"title": "Open Detail Report",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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 unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"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."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"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 list of a member's opens activity in a specific campaign."
},
"title": "Open Reports",
"description": "An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_opens": {
"type": "integer",
"title": "Total opens",
"description": "The total number of opens matching the query regardless of pagination."
}
},
"description": "A detailed report of any campaign emails that were opened by a list member."
}
ReportsListCampaignOpenDetailsdefaultResponse
{
"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'."
}
ReportsListCampaignRecipients200Response
{
"type": "object",
"title": "Sent-To",
"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."
},
"sent_to": {
"type": "array",
"items": {
"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."
},
"title": "Sent To",
"description": "An array of objects, each representing a campaign recipient."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of subscribers who were sent a specific campaign."
}
ReportsListCampaignRecipientsResponse
{
"type": "object",
"title": "Sent-To",
"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."
},
"sent_to": {
"type": "array",
"items": {
"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."
},
"title": "Sent To",
"description": "An array of objects, each representing a campaign recipient."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of subscribers who were sent a specific campaign."
}
ReportsListCampaignRecipientsdefaultResponse
{
"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'."
}
ReportsListCampaignReports200Response
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open 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."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a report resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of reports containing campaigns marked as Sent."
}
ReportsListCampaignReportsResponse
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open 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."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a report resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of reports containing campaigns marked as Sent."
}
ReportsListCampaignReportsdefaultResponse
{
"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'."
}
ReportsListChildCampaignReports200Response
{
"type": "object",
"title": "Campaign Sub-Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open 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."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Reports",
"description": "An array of objects, each representing a report resource."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "Unique identifier of the parent campaign"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of reports containing child campaigns for a specific campaign."
}
ReportsListChildCampaignReportsResponse
{
"type": "object",
"title": "Campaign Sub-Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open 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."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Reports",
"description": "An array of objects, each representing a report resource."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "Unique identifier of the parent campaign"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of reports containing child campaigns for a specific campaign."
}
ReportsListChildCampaignReportsdefaultResponse
{
"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'."
}
ReportsListClickedLinkSubscribers200Response
{
"type": "object",
"title": "Click Detail Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Member",
"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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"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."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"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 who clicked a specific URL in a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who clicked a specific link within a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 members who clicked on a specific link within a campaign."
}
ReportsListClickedLinkSubscribersResponse
{
"type": "object",
"title": "Click Detail Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Member",
"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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"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."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"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 who clicked a specific URL in a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who clicked a specific link within a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 members who clicked on a specific link within a campaign."
}
ReportsListClickedLinkSubscribersdefaultResponse
{
"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'."
}
ReportsListDomainPerformanceStats200Response
{
"type": "object",
"title": "Domain Performance",
"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."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Email Domain",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of opens for a domain."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks for a domain."
},
"domain": {
"type": "string",
"title": "Domain",
"readOnly": true,
"description": "The name of the domain (gmail.com, hotmail.com, yahoo.com)."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The total number of unsubscribes for a domain."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"readOnly": true,
"description": "The number of bounces at a domain."
},
"delivered": {
"type": "integer",
"title": "Successful Deliveries",
"readOnly": true,
"description": "The number of successful deliveries for a domain."
},
"opens_pct": {
"type": "number",
"title": "Opens Percent",
"readOnly": true,
"description": "The percentage of total opens from this domain."
},
"clicks_pct": {
"type": "number",
"title": "Clicks Percent",
"readOnly": true,
"description": "The percentage of total clicks from this domain."
},
"emails_pct": {
"type": "number",
"title": "Email Percent",
"readOnly": true,
"description": "The percentage of total emails that went to this domain."
},
"unsubs_pct": {
"type": "number",
"title": "Unsubscribes Percent",
"readOnly": true,
"description": "The percentage of total unsubscribes from this domain."
},
"bounces_pct": {
"type": "number",
"title": "Bounces Percent",
"readOnly": true,
"description": "The percentage of total bounces from this domain."
},
"emails_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The number of emails sent to that specific domain."
}
},
"description": "A single email domain's performance"
},
"title": "Lists",
"readOnly": true,
"description": "The top 5 email domains based on total delivered emails."
},
"total_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The total number of emails sent for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Statistics for the top-performing email domains in a campaign."
}
ReportsListDomainPerformanceStatsResponse
{
"type": "object",
"title": "Domain Performance",
"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."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Email Domain",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of opens for a domain."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks for a domain."
},
"domain": {
"type": "string",
"title": "Domain",
"readOnly": true,
"description": "The name of the domain (gmail.com, hotmail.com, yahoo.com)."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The total number of unsubscribes for a domain."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"readOnly": true,
"description": "The number of bounces at a domain."
},
"delivered": {
"type": "integer",
"title": "Successful Deliveries",
"readOnly": true,
"description": "The number of successful deliveries for a domain."
},
"opens_pct": {
"type": "number",
"title": "Opens Percent",
"readOnly": true,
"description": "The percentage of total opens from this domain."
},
"clicks_pct": {
"type": "number",
"title": "Clicks Percent",
"readOnly": true,
"description": "The percentage of total clicks from this domain."
},
"emails_pct": {
"type": "number",
"title": "Email Percent",
"readOnly": true,
"description": "The percentage of total emails that went to this domain."
},
"unsubs_pct": {
"type": "number",
"title": "Unsubscribes Percent",
"readOnly": true,
"description": "The percentage of total unsubscribes from this domain."
},
"bounces_pct": {
"type": "number",
"title": "Bounces Percent",
"readOnly": true,
"description": "The percentage of total bounces from this domain."
},
"emails_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The number of emails sent to that specific domain."
}
},
"description": "A single email domain's performance"
},
"title": "Lists",
"readOnly": true,
"description": "The top 5 email domains based on total delivered emails."
},
"total_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The total number of emails sent for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Statistics for the top-performing email domains in a campaign."
}
ReportsListDomainPerformanceStatsdefaultResponse
{
"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'."
}
ReportsListEepurlActivity200Response
{
"type": "object",
"title": "Eepurl Activity",
"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."
},
"clicks": {
"type": "object",
"title": "Click Summary",
"readOnly": true,
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The total number of clicks to the campaign's URL."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "Location",
"properties": {
"region": {
"type": "string",
"title": "Region",
"example": "NY",
"description": "If available, a specific region where the click was recorded."
},
"country": {
"type": "string",
"title": "Country",
"description": "The two-digit country code for a recorded click."
}
},
"description": "An individual click location."
},
"title": "Click Locations",
"readOnly": true,
"description": "A summary of the top click locations."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the last click to the URL."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the first click to the URL."
}
},
"description": "A summary of the click-throughs on the campaign's URL."
},
"eepurl": {
"type": "string",
"title": "Eepurl",
"readOnly": true,
"description": "The shortened link used for tracking."
},
"twitter": {
"type": "object",
"title": "Twitter Stats",
"properties": {
"tweets": {
"type": "integer",
"title": "Tweet Count",
"readOnly": true,
"description": "The number of tweets including a link to the campaign."
},
"retweets": {
"type": "integer",
"title": "Retweet Count",
"readOnly": true,
"description": "The number of retweets that include a link to the campaign."
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"title": "Twitter Status",
"properties": {
"status": {
"type": "string",
"title": "Status Body",
"readOnly": true,
"description": "The body of the tweet."
},
"datetime": {
"type": "string",
"title": "Datetime",
"format": "date-time",
"readOnly": true,
"description": "A timestamp for the tweet."
},
"status_id": {
"type": "string",
"title": "Status ID",
"readOnly": true,
"description": "The individual id for the tweet."
},
"is_retweet": {
"type": "boolean",
"title": "Is Retweet",
"readOnly": true,
"description": "A 'true' or 'false' status of whether the tweet is a retweet."
},
"screen_name": {
"type": "string",
"title": "Screen Name",
"readOnly": true,
"description": "The Twitter handle for the author of the tweet."
}
},
"description": "An individual tweet."
},
"title": "Twitter Status",
"readOnly": true,
"description": "A summary of tweets that include a link to the campaign."
},
"last_tweet": {
"type": "string",
"title": "Last Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the last recorded tweet with a link to the campaign."
},
"first_tweet": {
"type": "string",
"title": "First Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the first recorded tweet with a link to the campaign."
}
},
"description": "A summary of Twitter activity for a campaign."
},
"referrers": {
"type": "array",
"items": {
"type": "object",
"title": "Referrer",
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks a single referrer generated."
},
"referrer": {
"type": "string",
"title": "Referrer",
"description": "A referrer (truncated to 100 bytes)."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The timestamp for the last click from this referrer."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"description": "The timestamp for the first click from this referrer."
}
},
"description": "A single instance of a campaign referral."
},
"title": "Referrers",
"x-title": "Referrers",
"readOnly": true,
"description": "A summary of the top referrers for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of social activity for the campaign, tracked by EepURL."
}
ReportsListEepurlActivityResponse
{
"type": "object",
"title": "Eepurl Activity",
"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."
},
"clicks": {
"type": "object",
"title": "Click Summary",
"readOnly": true,
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The total number of clicks to the campaign's URL."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "Location",
"properties": {
"region": {
"type": "string",
"title": "Region",
"example": "NY",
"description": "If available, a specific region where the click was recorded."
},
"country": {
"type": "string",
"title": "Country",
"description": "The two-digit country code for a recorded click."
}
},
"description": "An individual click location."
},
"title": "Click Locations",
"readOnly": true,
"description": "A summary of the top click locations."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the last click to the URL."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the first click to the URL."
}
},
"description": "A summary of the click-throughs on the campaign's URL."
},
"eepurl": {
"type": "string",
"title": "Eepurl",
"readOnly": true,
"description": "The shortened link used for tracking."
},
"twitter": {
"type": "object",
"title": "Twitter Stats",
"properties": {
"tweets": {
"type": "integer",
"title": "Tweet Count",
"readOnly": true,
"description": "The number of tweets including a link to the campaign."
},
"retweets": {
"type": "integer",
"title": "Retweet Count",
"readOnly": true,
"description": "The number of retweets that include a link to the campaign."
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"title": "Twitter Status",
"properties": {
"status": {
"type": "string",
"title": "Status Body",
"readOnly": true,
"description": "The body of the tweet."
},
"datetime": {
"type": "string",
"title": "Datetime",
"format": "date-time",
"readOnly": true,
"description": "A timestamp for the tweet."
},
"status_id": {
"type": "string",
"title": "Status ID",
"readOnly": true,
"description": "The individual id for the tweet."
},
"is_retweet": {
"type": "boolean",
"title": "Is Retweet",
"readOnly": true,
"description": "A 'true' or 'false' status of whether the tweet is a retweet."
},
"screen_name": {
"type": "string",
"title": "Screen Name",
"readOnly": true,
"description": "The Twitter handle for the author of the tweet."
}
},
"description": "An individual tweet."
},
"title": "Twitter Status",
"readOnly": true,
"description": "A summary of tweets that include a link to the campaign."
},
"last_tweet": {
"type": "string",
"title": "Last Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the last recorded tweet with a link to the campaign."
},
"first_tweet": {
"type": "string",
"title": "First Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the first recorded tweet with a link to the campaign."
}
},
"description": "A summary of Twitter activity for a campaign."
},
"referrers": {
"type": "array",
"items": {
"type": "object",
"title": "Referrer",
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks a single referrer generated."
},
"referrer": {
"type": "string",
"title": "Referrer",
"description": "A referrer (truncated to 100 bytes)."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The timestamp for the last click from this referrer."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"description": "The timestamp for the first click from this referrer."
}
},
"description": "A single instance of a campaign referral."
},
"title": "Referrers",
"x-title": "Referrers",
"readOnly": true,
"description": "A summary of the top referrers for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of social activity for the campaign, tracked by EepURL."
}
ReportsListEepurlActivitydefaultResponse
{
"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'."
}
ReportsListEmailActivity200Response
{
"type": "object",
"title": "Email Activity",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Email Activity",
"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 unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"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 list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
},
"title": "Sent To",
"description": "An array of members that were sent the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the sent campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of member's subscriber activity in a specific campaign."
}
ReportsListEmailActivityResponse
{
"type": "object",
"title": "Email Activity",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Email Activity",
"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 unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"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 list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
},
"title": "Sent To",
"description": "An array of members that were sent the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the sent campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of member's subscriber activity in a specific campaign."
}
ReportsListEmailActivitydefaultResponse
{
"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'."
}
ReportsListTopOpenLocations200Response
{
"type": "object",
"title": "Open Locations",
"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."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of unique campaign opens for a region."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region."
},
"region_name": {
"type": "string",
"title": "Region Name",
"readOnly": true,
"description": "The name of the region, if we have one. For blank \"region\" values, this will be \"Rest of Country\"."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
}
}
},
"title": "Lists",
"description": "An array of objects, each representing a top location for opens."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Top open locations for a specific campaign."
}
ReportsListTopOpenLocationsResponse
{
"type": "object",
"title": "Open Locations",
"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."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of unique campaign opens for a region."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region."
},
"region_name": {
"type": "string",
"title": "Region Name",
"readOnly": true,
"description": "The name of the region, if we have one. For blank \"region\" values, this will be \"Rest of Country\"."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
}
}
},
"title": "Lists",
"description": "An array of objects, each representing a top location for opens."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Top open locations for a specific campaign."
}
ReportsListTopOpenLocationsdefaultResponse
{
"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'."
}
ReportsListUnsubscribedMembers200Response
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"unsubscribes": {
"type": "array",
"items": {
"type": "object",
"title": "Unsubscribes",
"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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"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."
}
},
"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 member who unsubscribed from a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who unsubscribed from a campaign."
}
},
"description": "A list of members who have unsubscribed from a specific campaign."
}
ReportsListUnsubscribedMembersResponse
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"unsubscribes": {
"type": "array",
"items": {
"type": "object",
"title": "Unsubscribes",
"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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The 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."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"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."
}
},
"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 member who unsubscribed from a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who unsubscribed from a campaign."
}
},
"description": "A list of members who have unsubscribed from a specific campaign."
}