Search campaigns

GET

https://api.mailchimp.com/3.0/search-campaigns

GET

/3.0/search-campaigns

curl -G https://api.mailchimp.com/3.0/search-campaigns \
     -H "Authorization: Bearer <token>" \
     -d query=query

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "results": [
    {
      "campaign": {
        "_links": [
          {
            "href": "string",
            "method": "GET",
            "rel": "string",
            "schema": "string",
            "targetSchema": "string"
          }
        ],
        "ab_split_opts": {
          "from_name_a": "string",
          "from_name_b": "string",
          "pick_winner": "opens",
          "reply_email_a": "string",
          "reply_email_b": "string",
          "send_time_a": "2024-01-15T09:30:00Z",
          "send_time_b": "2024-01-15T09:30:00Z",
          "send_time_winner": "string",
          "split_size": 1,
          "split_test": "subject",
          "subject_a": "string",
          "subject_b": "string",
          "wait_time": 1,
          "wait_units": "hours"
        },
        "archive_url": "string",
        "content_type": "template",
        "create_time": "2024-01-15T09:30:00Z",
        "delivery_status": {
          "can_cancel": true,
          "emails_canceled": 1,
          "emails_sent": 1,
          "enabled": true,
          "status": "delivering"
        },
        "emails_sent": 1,
        "id": "string",
        "long_archive_url": "string",
        "needs_block_refresh": true,
        "parent_campaign_id": "string",
        "recipients": {
          "list_id": "string",
          "list_is_active": true,
          "list_name": "string",
          "recipient_count": 1,
          "segment_opts": {
            "conditions": [
              {
                "condition_type": "Aim",
                "field": "aim",
                "op": "open",
                "value": "any"
              }
            ],
            "match": "any",
            "prebuilt_segment_id": "subscribers-female",
            "saved_segment_id": 1
          },
          "segment_text": "string"
        },
        "report_summary": {
          "click_rate": 1.1,
          "clicks": 1,
          "ecommerce": {
            "total_orders": 1,
            "total_revenue": 1.1,
            "total_spent": 1.1
          },
          "open_rate": 1.1,
          "opens": 1,
          "subscriber_clicks": 1,
          "unique_opens": 1
        },
        "resend_shortcut_eligibility": {
          "to_new_subscribers": {
            "is_eligible": true,
            "reason": "string"
          },
          "to_non_clickers": {
            "is_eligible": true,
            "reason": "string"
          },
          "to_non_openers": {
            "is_eligible": true,
            "reason": "string"
          },
          "to_non_purchasers": {
            "is_eligible": true,
            "reason": "string"
          }
        },
        "resend_shortcut_usage": {
          "original_campaign": {
            "id": "string",
            "shortcut_type": "non_openers",
            "title": "string",
            "web_id": 1
          },
          "shortcut_campaigns": [
            {
              "id": "string",
              "send_time": "2024-01-15T09:30:00Z",
              "shortcut_type": "non_openers",
              "status": "save",
              "web_id": 1
            }
          ]
        },
        "resendable": true,
        "rss_opts": {
          "constrain_rss_img": true,
          "feed_url": "string",
          "frequency": "daily",
          "last_sent": "2024-01-15T09:30:00Z",
          "schedule": {
            "daily_send": {
              "friday": true,
              "monday": true,
              "saturday": true,
              "sunday": true,
              "thursday": true,
              "tuesday": true,
              "wednesday": true
            },
            "hour": 1,
            "monthly_send_date": 1.1,
            "weekly_send_day": "sunday"
          }
        },
        "send_time": "2024-01-15T09:30:00Z",
        "settings": {
          "authenticate": true,
          "auto_fb_post": [
            "string"
          ],
          "auto_footer": true,
          "auto_tweet": true,
          "drag_and_drop": true,
          "fb_comments": true,
          "folder_id": "string",
          "from_name": "string",
          "inline_css": true,
          "preview_text": "string",
          "reply_to": "string",
          "subject_line": "string",
          "template_id": 1,
          "timewarp": true,
          "title": "string",
          "to_name": "string",
          "use_conversation": true
        },
        "social_card": {
          "description": "string",
          "image_url": "string",
          "title": "string"
        },
        "status": "save",
        "tracking": {
          "capsule": {
            "notes": true
          },
          "clicktale": "string",
          "ecomm360": true,
          "goal_tracking": true,
          "google_analytics": "string",
          "html_clicks": true,
          "opens": true,
          "salesforce": {
            "campaign": true,
            "notes": true
          },
          "text_clicks": true
        },
        "type": "regular",
        "variate_settings": {
          "combinations": [
            {
              "content_description": 1,
              "from_name": 1,
              "id": "string",
              "recipients": 1,
              "reply_to": 1,
              "send_time": 1,
              "subject_line": 1
            }
          ],
          "contents": [
            "string"
          ],
          "from_names": [
            "string"
          ],
          "reply_to_addresses": [
            "string"
          ],
          "send_times": [
            "2024-01-15T09:30:00Z"
          ],
          "subject_lines": [
            "string"
          ],
          "test_size": 1,
          "wait_time": 1,
          "winner_criteria": "opens",
          "winning_campaign_id": "string",
          "winning_combination_id": "string"
        },
        "web_id": 1
      },
      "snippet": "string"
    }
  ],
  "total_items": 1
}

Search all campaigns for the specified query terms.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

querystringRequired

The search query used to filter results.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

resultslist of objectsOptional

An array of matching campaigns and snippets.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.