/mailchimp-reports | Type: Application | PCID required: Yes
Tools
mailchimp_reports_get_id
Get campaign report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_abuse_reports_id
List abuse reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_abuse_reports_id_id
Get abuse report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
report_id | string | Yes | — | The id for the abuse report. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"report_id": {
"type": "string",
"description": "The id for the abuse report."
}
},
"required": [
"PCID",
"campaign_id",
"report_id"
]
}
mailchimp_reports_get_id_advice
List campaign feedback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_click_details
List campaign details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
sort_field | string | No | — | Returns click reports sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"sort_field": {
"type": "string",
"description": "Returns click reports sorted by the specified field.",
"enum": [
"total_clicks",
"unique_clicks"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_click_details_id
Get campaign link details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
link_id | string | Yes | — | The id for the link. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"link_id": {
"type": "string",
"description": "The id for the link."
}
},
"required": [
"PCID",
"campaign_id",
"link_id"
]
}
mailchimp_reports_get_id_click_details_id_members
List clicked link subscribers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
link_id | string | Yes | — | The id for the link. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"link_id": {
"type": "string",
"description": "The id for the link."
}
},
"required": [
"PCID",
"campaign_id",
"link_id"
]
}
mailchimp_reports_get_id_click_details_id_members_id
Get clicked link subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
link_id | string | Yes | — | The id for the link. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"link_id": {
"type": "string",
"description": "The id for the link."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"campaign_id",
"link_id",
"subscriber_hash"
]
}
mailchimp_reports_get_id_domain_performance
List domain performance stats Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_ecommerce_product_activity
List campaign product activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
sort_field | string | No | — | Returns files sorted by the specified field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"title",
"total_revenue",
"total_purchased"
]
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_eepurl
List EepURL activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_email_activity
List email activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
since | string | No | — | Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"since": {
"type": "string",
"description": "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_email_activity_id
Get subscriber email activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
since | string | No | — | Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"since": {
"type": "string",
"description": "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
}
},
"required": [
"PCID",
"campaign_id",
"subscriber_hash"
]
}
mailchimp_reports_get_id_locations
List top open activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_open_details
List campaign open details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
since | string | No | — | Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
sort_field | string | No | — | Returns open reports sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"since": {
"type": "string",
"description": "Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"sort_field": {
"type": "string",
"description": "Returns open reports sorted by the specified field.",
"enum": [
"opens_count"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_open_details_id_members_id
Get opened campaign subscriber Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"campaign_id",
"subscriber_hash"
]
}
mailchimp_reports_get_id_sent_to
List campaign recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_sent_to_id
Get campaign recipient info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"campaign_id",
"subscriber_hash"
]
}
mailchimp_reports_get_id_sub_reports_id
List child campaign reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_unsubscribed
List unsubscribed members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
campaign_id | string | Yes | — | The unique id for the campaign. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
}
},
"required": [
"PCID",
"campaign_id"
]
}
mailchimp_reports_get_id_unsubscribed_id
Get unsubscribed member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
campaign_id | string | Yes | — | The unique id for the campaign. |
subscriber_hash | string | Yes | — | The MD5 hash of the lowercase version of the list member’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"campaign_id": {
"type": "string",
"description": "The unique id for the campaign."
},
"subscriber_hash": {
"type": "string",
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"required": [
"PCID",
"campaign_id",
"subscriber_hash"
]
}
mailchimp_reports_get_reporting_facebook_ads
List facebook ads reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
sort_field | string | No | — | Returns files sorted by the specified field. |
sort_dir | string | No | — | Determines the order direction for sorted results. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"created_at",
"updated_at",
"end_time"
]
},
"sort_dir": {
"type": "string",
"description": "Determines the order direction for sorted results.",
"enum": [
"ASC",
"DESC"
]
}
},
"required": [
"PCID"
]
}
mailchimp_reports_get_reporting_facebook_ads_id
Get facebook ad report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
outreach_id | string | Yes | — | The outreach id. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"outreach_id": {
"type": "string",
"description": "The outreach id."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
}
},
"required": [
"PCID",
"outreach_id"
]
}
mailchimp_reports_get_reporting_facebook_ads_id_ecommerce_product_activity
List facebook ecommerce report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
outreach_id | string | Yes | — | The outreach id. |
sort_field | string | No | — | Returns files sorted by the specified field. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"outreach_id": {
"type": "string",
"description": "The outreach id."
},
"sort_field": {
"type": "string",
"description": "Returns files sorted by the specified field.",
"enum": [
"title",
"total_revenue",
"total_purchased"
]
}
},
"required": [
"PCID",
"outreach_id"
]
}
mailchimp_reports_get_reporting_landing_pages
List landing pages reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID"
]
}
mailchimp_reports_get_reporting_landing_pages_id
Get landing page report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
outreach_id | string | Yes | — | The outreach id. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"outreach_id": {
"type": "string",
"description": "The outreach id."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
}
},
"required": [
"PCID",
"outreach_id"
]
}
mailchimp_reports_get_reporting_surveys
List survey reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
}
},
"required": [
"PCID"
]
}
mailchimp_reports_get_reporting_surveys_id
Get survey report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
survey_id | string | Yes | — | The ID of the survey. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
}
},
"required": [
"PCID",
"survey_id"
]
}
mailchimp_reports_get_reporting_surveys_id_questions
List survey question reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
survey_id | string | Yes | — | The ID of the survey. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
}
},
"required": [
"PCID",
"survey_id"
]
}
mailchimp_reports_get_reporting_surveys_id_questions_id
Get survey question report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
survey_id | string | Yes | — | The ID of the survey. |
question_id | string | Yes | — | The ID of the survey question. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
},
"question_id": {
"type": "string",
"description": "The ID of the survey question."
}
},
"required": [
"PCID",
"survey_id",
"question_id"
]
}
mailchimp_reports_get_reporting_surveys_id_questions_id_answers
List answers for question Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
survey_id | string | Yes | — | The ID of the survey. |
question_id | string | Yes | — | The ID of the survey question. |
respondent_familiarity_is | string | No | — | Filter survey responses by familiarity of the respondents. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
},
"question_id": {
"type": "string",
"description": "The ID of the survey question."
},
"respondent_familiarity_is": {
"type": "string",
"description": "Filter survey responses by familiarity of the respondents.",
"enum": [
"new",
"known",
"unknown"
]
}
},
"required": [
"PCID",
"survey_id",
"question_id"
]
}
mailchimp_reports_get_reporting_surveys_id_responses
List survey responses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
survey_id | string | Yes | — | The ID of the survey. |
answered_question | integer | No | — | The ID of the question that was answered. |
chose_answer | string | No | — | The ID of the option chosen to filter responses on. |
respondent_familiarity_is | string | No | — | Filter survey responses by familiarity of the respondents. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
},
"answered_question": {
"type": "integer",
"description": "The ID of the question that was answered."
},
"chose_answer": {
"type": "string",
"description": "The ID of the option chosen to filter responses on."
},
"respondent_familiarity_is": {
"type": "string",
"description": "Filter survey responses by familiarity of the respondents.",
"enum": [
"new",
"known",
"unknown"
]
}
},
"required": [
"PCID",
"survey_id"
]
}
mailchimp_reports_get_reporting_surveys_id_responses_id
Get survey response Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
survey_id | string | Yes | — | The ID of the survey. |
response_id | string | Yes | — | The ID of the survey response. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"survey_id": {
"type": "string",
"description": "The ID of the survey."
},
"response_id": {
"type": "string",
"description": "The ID of the survey response."
}
},
"required": [
"PCID",
"survey_id",
"response_id"
]
}
mailchimp_reports_get_reports
List campaign reports Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string[] | No | — | A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields | string[] | No | — | A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
count | integer | No | — | The number of records to return. Default value is 10. Maximum value is 1000 |
offset | integer | No | — | Used for pagination, this is the number of records from a collection to skip. Default value is 0. |
type | string | No | — | The campaign type. |
before_send_time | string | No | — | Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
since_send_time | string | No | — | Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation."
},
"exclude_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation."
},
"count": {
"type": "integer",
"description": "The number of records to return. Default value is 10. Maximum value is 1000"
},
"offset": {
"type": "integer",
"description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0."
},
"type": {
"type": "string",
"description": "The campaign type.",
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
]
},
"before_send_time": {
"type": "string",
"description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
},
"since_send_time": {
"type": "string",
"description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00."
}
},
"required": [
"PCID"
]
}

