Emma API Documentation

Response

We know that you want to do some fancy pivot tables with your response data, so we’ve provided quite a few endpoints here to give you access to that response data. You can get overview numbers for all of your mailings and also drill down into finding out the actual members who opened a particular mailing.

GET /#account_id/response

Get the response summary for an account.

This method will return a month-based time series of data including sends, opens, clicks, mailings, forwards, and opt-outs. Test mailings and forwards are not included in the data returned.

Returns:

A list of objects with each object representing one month. Each object contains:

  • account_id – The account_id for this line of stats
  • month – two digit integer for month
  • year – four digit integer for year
  • mailings – number of mailings sent
  • sent – number of messages sent
  • delivered – number of messages delivered
  • bounced – number of messages that failed delivery due to a hard or soft bounce
  • opened – number of messages opened
  • clicked_unique – link clicks, unique on message
  • clicked – total link clicks, including duplicates
  • forwarded – times the mailing was forwarded
  • shared – total times a mailing has been shared
  • share_clicked – total times a shared mailing has been seen
  • webview_shared – total times a customer has shared their mailing
  • webview_share_clicked – total times a customer-shared mailing has been seen
  • opted_out – people who opted out based on this mailing
  • signed_up – people who signed up based on this mailing
  • count_purchased – the total number of orders made
  • sum_purchased – the total dollar amount of orders
Parameters:
  • include_deleted (boolean) – Accepts 1. All other values are False. Optional flag to include archived mailings in the list.
  • range (string) – Accepts 2 dates (YYYY-MM-DD) delimited by a tilde (~). Example: 2011-04-01~2011-09-01 Optional argument to limit results to a date range. If one of the dates is omitted, the default will be either min date or now. If a single date is provided with no tilde, then only mailings sent on that date will be included.

Sample Response [showhide]
GET /100/response

[
  {
    "count_purchased": 0,
    "delivered": 0,
    "clicked": 0,
    "account_id": 100,
    "clicked_unique": 0,
    "shared": 0,
    "mailings": 0,
    "year": 2018,
    "month": 4,
    "opened": 7,
    "opted_out": 0,
    "sent": 0,
    "signed_up": 0,
    "webview_shared": 0,
    "share_clicked": 0,
    "bounced": 0,
    "webview_share_clicked": 0,
    "sum_purchased": 0,
    "forwarded": 0
  },
  {
    "count_purchased": 0,
    "delivered": 0,
    "clicked": 0,
    "account_id": 100,
    "clicked_unique": 0,
    "shared": 0,
    "mailings": 0,
    "year": 2018,
    "month": 3,
    "opened": 0,
    "opted_out": 0,
    "sent": 0,
    "signed_up": 0,
    "webview_shared": 0,
    "share_clicked": 0,
    "bounced": 0,
    "webview_share_clicked": 0,
    "sum_purchased": 0,
    "forwarded": 0
  }
]

Sample Response [showhide]
GET /100/response?range=2018-04-01~2018-06-01

[
  {
    "count_purchased": 0,
    "delivered": 0,
    "clicked": 0,
    "account_id": 100,
    "clicked_unique": 0,
    "shared": 0,
    "mailings": 0,
    "year": 2018,
    "month": 5,
    "opened": 0,
    "opted_out": 0,
    "sent": 0,
    "signed_up": 0,
    "webview_shared": 0,
    "share_clicked": 0,
    "bounced": 0,
    "webview_share_clicked": 0,
    "sum_purchased": 0,
    "forwarded": 0
  },
  {
    "count_purchased": 0,
    "delivered": 0,
    "clicked": 0,
    "account_id": 100,
    "clicked_unique": 0,
    "shared": 0,
    "mailings": 0,
    "year": 2018,
    "month": 4,
    "opened": 0,
    "opted_out": 0,
    "sent": 0,
    "signed_up": 0,
    "webview_shared": 0,
    "share_clicked": 0,
    "bounced": 0,
    "webview_share_clicked": 0,
    "sum_purchased": 0,
    "forwarded": 0
  }
]

GET /#account_id/response/#mailing_id

Get the response summary for a particular mailing.

This method will return the counts of each type of response activity for a particular mailing.

Returns:
A single object with the following fields:
  • name – name of mailing
  • subject – subject of the mailing
  • recipient_count – count of people this mailing was sent to
  • sent – messages sent
  • delivered – messages delivered
  • in_progress – messages still being attempted
  • bounced – messages that failed delivery due to a hard or soft bounce
  • opened – messages opened
  • clicked_unique – link clicks, unique on message
  • clicked – total link clicks, including duplicates
  • forwarded – times the mailing was forwarded
  • opted_out – people who opted out based on this mailing
  • signed_up – people who signed up based on this mailing
  • shared – people who shared this mailing
  • share_clicked – number of clicks shares of this mailing received
  • webview_shared – number of times the customer has shared
  • webview_share_clicked – number of clicks customer-shares of this mailing received
  • count_purchased – the total number of ecommerce orders (this value will be 0 for accounts not using an ecommerce integration)
  • sum_purchased – the total dollar amount of all ecommerce orders (this value will be 0 for accounts not using an ecommerce integration)
  • purchase_metrics – an object containing purchase metrics if ecommerce integrations are enabled (this object will be empty for accounts not using an ecommerce integration)
  • Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200
    
    {
      "purchase_metrics": {},
      "subject": "Sample Mailing for [% member:first_name %] [% member:last_name %]",
      "count_purchased": 0,
      "delivered": 0,
      "clicked": 0,
      "opened": 0,
      "webview_shared": 0,
      "recipient_count": 0,
      "sent": 0,
      "clicked_unique": 0,
      "webview_share_clicked": 0,
      "shared": 0,
      "in_progress": 0,
      "sum_purchased": 0,
      "forwarded": 0,
      "name": "Sample Mailing",
      "opted_out": 0,
      "signed_up": 0,
      "share_clicked": 0,
      "bounced": 0
    }
    

    GET /#account_id/response/#mailing_id/sends

    Get the list of messages that have been sent to an MTA for delivery.

    Returns:

    An array of objects with the following fields:

    • timestamp – time the message was sent
    • member_id – id of the message addressee
    • member_since – time member was added to your audience
    • email – email of the message addressee
    • email_user – email user of the message addressee
    • email_domain – email domain of the message addressee
    • member_status_id – addressee's status; a (active), e (error), o (opt out), or f (forward)
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/sends
    
    [
      {
        "fields": {
          "first_name": "Emma",
          "last_name": "Smith",
          "favorite_food": "tacos"
        },
        "timestamp": "@D:2018-01-12T10:27:40",
        "member_id": 200,
        "member_since": "@D:2017-11-12T11:23:45",
        "email_domain": "myemma.com",
        "email_user": "emma",
        "email": "emma@myemma.com",
        "member_status_id": "a"
      },
      {
        "fields": {
          "first_name": "Gladys",
          "last_name": "Jones",
          "favorite_food": "toast"
        },
        "timestamp": "@D:2018-01-12T10:27:40",
        "member_id": 201,
        "member_since": "@D:2018-01-03T15:54:13",
        "email_domain": "myemma.com",
        "email_user": "gladys",
        "email": "gladys@myemma.com",
        "member_status_id": "o"
      },
      {
        "fields": {
    
        },
        "timestamp": "@D:2018-01-12T10:27:43",
        "member_id": 204,
        "member_since": "@D:2017-12-13T23:12:44",
        "email_domain": "myemma.com",
        "email_user": "bob",
        "email": "bob@myemma.com",
        "member_status_id": "e"
      },
      {
        "fields": {
          "first_name": "Han",
          "last_name": "Smith",
          "favorite_food": "chocolate pudding"
        },
        "timestamp": "@D:2018-01-12T10:27:43",
        "member_id": 201,
        "member_since": "@D:2018-01-03T15:54:13",
        "email_domain": "myemma.com",
        "email_user": "gladys",
        "email": "gladys@myemma.com",
        "member_status_id": "f"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/in_progress

    Get the list of messages that are in the queue, possibly sent, but not yet delivered.

    Returns:

    An array of objects with the following fields:

    • member_id – id of the message addressee
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/in_progress
    
    [
      {
        "fields": {
          "first_name": "Gladys",
          "last_name": "Jones",
          "favorite_food": "toast"
        },
        "member_id": 201,
        "member_since": "@D:2011-01-03T15:54:13",
        "email_domain": "myemma.com",
        "email_user": "gladys",
        "email": "gladys@myemma.com",
        "member_status_id": "o"
      },
      {
        "fields": {
    
        },
        "member_id": 204,
        "member_since": "@D:2010-12-13T23:12:44",
        "email_domain": "myemma.com",
        "email_user": "bob",
        "email": "bob@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/deliveries

    Get the list of messages that have finished delivery.

    This will include those that were successfully delivered, as well as those that failed due to hard or soft bounces.

    This list can be limited by delivery_type.

    Parameters:
    • delivery_type (string) – Accepted options: ‘all’, ‘delivered’, ‘bounced’, ‘hard’, ‘soft’. Defaults to ‘all’, if not provided.
    • del_status (string) – Accepted options: ‘all’, ‘delivered’, ‘bounced’, ‘hard’, ‘soft’. Defaults to ‘all’, if not provided.
    • include_custom_fields (boolean) – flag to include custom member fields (defaults to true).
    • include_children (boolean) – flag to include child mailings (defaults to true)
    Returns:

    An array of objects with the following fields:

    • timestamp – time the message was delivered
    • delivery_type – delivery outcome: delivered, hard, (bounce), or soft (bounce)
    • member_id – id of the message addressee
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/deliveries
    
    [
      {
        "delivery_type": "delivered",
        "email_domain": "myemma.com",
        "fields": {
          "first_name": "Emma",
          "last_name": "Smith",
          "favorite_food": "tacos"
        },
        "mailing_id": 200,
        "timestamp": "@D:2011-01-02T10:29:36",
        "member_id": 200,
        "member_status_id": "a",
        "member_since": "@D:2010-11-12T11:23:45",
        "mailing_name": "Sample Mailing",
        "email_user": "emma",
        "email": "emma@myemma.com"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/opens

    Get the list of opened messages for this campaign.

    Returns:

    An array of objects with the following fields:

    • timestamp – time the message was opened
    • member_id – id of the message addressee
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/opens
    
    [
      {
        "fields": {
          "first_name": "Emma",
          "last_name": "Smith",
          "favorite_food": "tacos"
        },
        "timestamp": "@D:2011-01-02T11:13:51",
        "member_id": 200,
        "member_since": "@D:2010-11-12T11:23:45",
        "email_domain": "myemma.com",
        "email_user": "emma",
        "email": "emma@myemma.com",
        "member_status_id": "a"
      },
      {
        "fields": {
    
        },
        "timestamp": "@D:2011-01-02T13:55:51",
        "member_id": 204,
        "member_since": "@D:2010-12-13T23:12:44",
        "email_domain": "myemma.com",
        "email_user": "bob",
        "email": "bob@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/opens/#member_id

    Determine if the specified member opened the mailing.

    Returns:

    True or False depending on if the member opened the specified mailing

    Get the list of links for this mailing.

    Returns:

    An array of objects with the following fields:

    • link_id – If the mailing is not a trigger, the individual id of the link will be included
    • link_order – order of the link in the mailing
    • link_name – friendly name for the link
    • link_target – link URL
    • plaintext – boolean, is the link plaintext
    • unique_clicks – clicks on the link, unique per message
    • total_clicks – clicks on the link, total
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/links
    
    [
      {
        "link_order": 1,
        "link_name": "Emma",
        "unique_clicks": 1,
        "plaintext": false,
        "link_target": "http://www.myemma.com",
        "total_clicks": 1,
        "link_id": 200
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/clicks

    Get the list of clicks for this mailing.

    This list can also be limited by member_id or link_id.

    Parameters:
    • member_id (int) – Limits results to a single member.
    • link_id (int) – Limits results to a single link.
    • include_custom_fields (boolean) – flag to include custom member fields (defaults to true).
    • include_children (boolean) – flag to include child mailings (defaults to true).
    Returns:

    An array of objects with the following fields:

    • link_id – id of the clicked link
    • timestamp – time the link was clicked
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/clicks
    
    [
      {
        "link_id": 200,
        "fields": {
          "first_name": "Emma",
          "last_name": "Smith",
          "favorite_food": "tacos"
        },
        "timestamp": "@D:2011-01-02T11:14:32",
        "member_id": 200,
        "member_since": "@D:2010-11-12T11:23:45",
        "email_domain": "myemma.com",
        "email_user": "emma",
        "email": "emma@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/clicks/#member_id

    Get the list of clicks for this mailing for the specified member.

    Returns:

    An array of objects with the following fields:

    • link_id – id of the clicked link
    • link_name – name of the link
    • link_target – link url
    • plaintext – bool, is link plaintext
    • timestamp – timestamp when link was clicked
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid

    Sample Response [showhide]
    GET /100/response/200/clicks/300
    
    [
      {
        "plaintext": false,
        "timestamp": "@D:2018-09-12T15:22:03",
        "link_name": "Emma",
        "link_target": "http://www.myemma.com",
        "link_id": 400
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/forwards

    Get the list of forwards for this mailing.

    Returns:

    An array of objects with the following fields:

    • timestamp – time the mailing was forwarded
    • forward_mailing_id – id of the new mailing created to send the forward
    • member_id – id of the forwarding member
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/forwards
    
    [
      {
        "forward_mailing_id": 401,
        "fields": {},
        "timestamp": "@D:2018-05-02T14:35:38",
        "member_id": 300,
        "member_since": "@D:2017-01-04T08:40:06",
        "email_domain": "myemma.com",
        "email_user": "susansmith",
        "email": "susansmit@myemma.com",
        "member_status_id": "a"
      },
      {
        "forward_mailing_id": 400,
        "fields": {},
        "timestamp": "@D:2018-05-02T14:41:16",
        "member_id": 500,
        "member_since": "@D:2018-01-03T09:33:24",
        "email_domain": "myemma.com",
        "email_user": "janedoe",
        "email": "janedoe@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/optouts

    Get the list of optouts for this mailing.

    Returns:

    An array of objects with the following fields:

    • timestamp – time of the optout
    • member_id – id of the opted out member
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/optouts
    
    [
      {
        "fields": {},
        "timestamp": "@D:2011-01-02T13:56:16",
        "member_id": 204,
        "member_since": "@D:2010-12-13T23:12:44",
        "email_domain": "myemma.com",
        "email_user": "bob",
        "email": "bob@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/signups

    Get the list of signups for this mailing.

    Returns:

    An array of objects with the following fields:

    • member_id – id of the signed up member
    • timestamp – time of the signup
    • ref_member_id – id of the referring member
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.

    Sample Response [showhide]
    GET /100/response/200/signups
    
    [
      {
        "ref_member_id": 200,
        "mailing_mailing_id": 200,
        "fields": {},
        "timestamp": "@D:2011-01-05T15:28:11",
        "member_id": 205,
        "member_since": "@D:2011-01-05T15:28:11",
        "email_domain": "myemma.com",
        "email_user": "newbie",
        "email": "newbie@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/shares

    Get the list of shares for this mailing

    Returns:

    An array of objects with the following fields:

    • member_id – id of the shared message
    • network – name of the network the share happened on
    • share_clicks – number of clicks that the shared link received
    • email – email of the message addressee
    • email_user – email user of the addressee
    • email_domain – email domain of the addressee
    • member_since – date member was added to audience
    • member_status_id – status of the member
    • fields – member field object

    Sample Response [showhide]
    GET /100/response/200/shares
    
    [
      {
        "network": "email",
        "share_clicks": 0,
        "fields": {},
        "timestamp": "@D:2018-05-02T14:35:25",
        "member_id": 123,
        "member_since": "@D:2017-01-04T08:40:06",
        "email_domain": "myemma.com",
        "email_user": "johnsmith",
        "email": "johnsmith@myemma.com",
        "member_status_id": "a"
      },
      {
        "network": "email",
        "share_clicks": 0,
        "fields": {},
        "timestamp": "@D:2018-05-02T14:40:38",
        "member_id": 456,
        "member_since": "@D:2018-01-03T09:33:24",
        "email_domain": "myemma.com",
        "email_user": "someone",
        "email": "someone@myemma.com",
        "member_status_id": "a"
      }
    ]
    
    

    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.
    GET /#account_id/response/#mailing_id/customer_shares

    Get the list of customer shares for this mailing

    Returns:

    An array of objects with the following fields:

    • timestamp – timestamp of the shared link click
    • network – name of the network the share happened on
    • customer_shares – number of shares

    Sample Response [showhide]
    GET /100/response/200/customer_shares
    
    [
      {
        "timestamp": "@D:2017-05-25T16:00:00",
        "customer_shares": 0,
        "network": "facebook"
      }
    ]
    
    

    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.
    GET /#account_id/response/#mailing_id/customer_share_clicks

    Get the list of customer share clicks for this mailing

    Returns:

    An array of objects with the following fields:

    • timestamp – timestamp of the shared link click
    • network – name of the network the share happened on
    • customer_share_clicks – number of clicks that the shared link received

    Sample Response [showhide]
    GET /100/response/200/customer_share_clicks
    
    [
      {
        "timestamp": "@D:2017-05-25T16:00:03",
        "network": "facebook",
        "customer_share_clicks": 1
      },
      {
        "timestamp": "@D:2017-05-25T16:00:15",
        "network": "facebook",
        "customer_share_clicks": 1
      }
    ]
    
    

    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.
    GET /#account_id/response/#share_id/customer_share

    Get the customer share associated with the share id.

    Returns:

    An object with the following fields:

    • timestamp – timestamp of the share
    • network – name of the network the share happened on
    • share_status – status of the share

    Sample Response [showhide]
    GET /100/response/300/customer_share
    
    {
      "timestamp": "@D:2018-02-17T08:33:23",
      "network": "facebook",
      "share_status": "c"
    }
    
    

    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid mailing type - ‘m’ for standard mailings, ‘t’ for test mailings, ‘s’ for subject split test mailings, and ‘r’ for trigger mailings.
    PUT /#account_id/response/#mailing_id/customer_share_status

    Update a customer share status.

    Parameters:
    • status_to (str) – The status to which you want to change the customer share. Options include: x - mailing has been cancelled, share was not posted. c - share has been successfully posted. r - network access has been revoked.
    • share_id (int) – The id of the share you want to update.
    Returns:

    The updated status of the customer share.

    Raises:Http404 if the customer share does not exist.
    Raises:Http404 if the mailing does not exist
    GET /#account_id/response/#mailing_id/shares/overview

    Get overview of shares pertaining to this mailing_id.

    Returns:

    An array of objects with the following fields:

    • network – name of the network the share happened on
    • share_clicks – number of clicks that the shared link received
    • share_count – number of shares to that network
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not valid

    Sample Response [showhide]
    GET /100/response/200/shares/overview
    
    [
      {
        "share_count": 0,
        "share_clicks": 0,
        "network": "email"
      },
      {
        "share_count": 0,
        "share_clicks": 0,
        "network": "linkedin"
      },
      {
        "share_count": 0,
        "share_clicks": 0,
        "network": "twitter"
      }
    ]
    
    

    GET /#account_id/response/#mailing_id/split_test_info

    Get information about the split test for the given parent mailing_id.

    Returns:

    An object with the following attributes:

    • test_in_progress – boolean indicating whether the test is still underway
    • autosend_on – boolean indicating whether the test will (or did) autosend on completion
    • autosend_time – timestamp when the test will (or did) autosend. If autosend_on is false, this will be null
    • num_test_recipients – number of recipients that received a test message
    • test_started_ts – the timestamp of when the test started
    • test_ended_ts – the timetamp of when the test ended
    • winner_auto – the mailing id that was automatically determined to be the winner
    • winner_manual – the mailing id that was manually chosen as the winner
    • responses – an array of objects with the same fields as those returned by get_response_overview, plus:
      variant – - an identifier for the variant this is the response data for. It will be 'a' 'b' or 'c'.
      opened_pct – - the percentage of sent emails that were opened
      clicked_pct – - the percentage of sent emails that were clicked
      shared_pct – - the percentge of opened emails that were shared
      signed_up_pct – - the percentage of opened emails that had signups
      opted_out_pct – - the percentage of delivered emails that had optouts
      winner – - if present, indicates that this variant was the winner
      subject – - the subject of the given variant
    Raises:Http404 if the mailing does not exist.
    Raises:Http404 if the mailing is not a split_test parent mailing

    Sample Response [showhide]
    GET /100/response/200/split_test_info
    
    {
      "test_started_ts": "@D:2018-09-10T08:52:27",
      "autosend_time": "@D:2018-09-10T09:52:27",
      "responses": [
        {
          "clicked_pct": 0,
          "delivered": 0,
          "opened_pct": 00.0,
          "clicked": 0,
          "opened": 0,
          "clicked_unique": 0,
          "opted_out_pct": 0,
          "mailing_id": 300,
          "is_winner": true,
          "variant": "a",
          "subject": "A",
          "opted_out": 0,
          "signed_up_pct": 0,
          "signed_up": 0,
          "shared": 0,
          "share_clicked": 0,
          "bounced": 0,
          "shared_pct": 0,
          "sent": 0,
          "forwarded": 0
        },
        {
          "clicked_pct": 0,
          "delivered": 0,
          "opened_pct": 0,
          "clicked": 0,
          "opened": 0,
          "clicked_unique": 0,
          "opted_out_pct": 0,
          "mailing_id": 400,
          "is_winner": false,
          "variant": "b",
          "subject": "B",
          "opted_out": 0,
          "signed_up_pct": 0,
          "signed_up": 0,
          "shared": 0,
          "share_clicked": 0,
          "bounced": 0,
          "shared_pct": 0,
          "sent": 0,
          "forwarded": 0
        }
      ],
      "test_in_progress": false,
      "test_ended_ts": "@D:2018-09-10T09:53:04",
      "winner_manual": null,
      "autosend_on": true,
      "winner_auto": 300,
      "num_test_recipients": 0
    }
    
    

    Related Topics

    Interested in Emma?

    Emma's email marketing makes communicating simple and stylish. Get started today.