GreenArrow Email Software Documentation

Autoresponders API

Remote Lists

Autoresponders are not available on Remote Lists.

API calls to these endpoints will return an error message if attempted on a Remote List.

Autoresponder Attributes

autoresponder

hash


id

integer

/

read-only

The autoresponder’s internal identifier.

mailing_list_id

integer

/

read-only

The mailing list ID.

name

string

/

required

The descriptive name of this autoresponder.

paused

boolean

/

default: false

This autoresponder is paused. Reactions will accrue while paused, but no deliveries will be made until it is unpaused.

paused_at

string

/

read-only

The time at which this Autoresponder was paused. If the Autoresponder is not currently paused, this will be null.

trigger

string

/

required



The type of action that this autoresponder triggers on. Other attributes of the autoresponder are dependent on this trigger type.

Valid trigger types include:

subscription

A new subscriber was added to the mailing list.

campaign_open

A subscriber has opened a particular Campaign for the first time.

campaign_click

A subscriber has clicked on a link in a particular Campaign for the first time.

  • This trigger may be configured to react to a particular link or on any link.
autoresponder_open

A subscriber has opened a particular Autoresponder for the first time.

autoresponder_nonopen

A subscriber was sent a particular Autoresponder but did not open it by the time the configured delay expired.

autoresponder_click

A subscriber has clicked on a link in a particular Autoresponder for the first time.

  • This trigger may be configured to react to a particular link or on any link.
autoresponder_nonclick

A subscriber was sent a particular Autoresponder but did not click on a link in it by the time the configured delay has expired.

  • This trigger may be configured to react to a particular link or on any link.
autoresponder_send

A subscriber was sent a particular Autoresponder.

delay

string

/

required



Indicate whether or not this autoresponder is delayed.

Valid delay types include:

immediately

Run the reaction immediately.

with_delay

Run the reaction with a configured delay. See the fields delay_amount, delay_unit, and delay_time for determining the length of the delay.

delay_amount

integer

The number of time units to delay this autoresponder. This field is paired with delay_unit to determine the delay duration.

delay_amount=2 and delay_unit=hours = Delay for 2 hours.

delay_amount=7 and delay_unit=days = Delay for 7 days.

  • When delay is with_delay, this must be an integer greater than or equal to 0
delay_unit

string



The time unit to delay the autoresponder. See the description of delay_amount above.

Valid delay units include:

minutes

The reaction will occur delay_amount minutes after the event triggered.

hours

The reaction will occur delay_amount hours after the event triggered.

days

The reaction will occur at delay_time am/pm, delay_amount days after the event triggered.

weeks

The reaction will occur at delay_time am/pm, delay_amount weeks after the event triggered.

months

The reaction will occur at delay_time am/pm, delay_amount months after the event triggered.

delay_time

integer

The hour of the day at which the autoresponder will send its emails.

  • This field is only valid and is required if delay_unit is one of: days, weeks, or months
  • Must be an integer greater than or equal to 0 and less than or equal to 23
trigger_include_subscribers_from_import

boolean

/

default: false

This autoresponder should run on subscribers added from Subscriber Imports. Any individual Subscriber Import may still opt to prevent autoresponders from triggering.

This option only applies to autoresponders with trigger=subscription.

trigger_run_on_api

boolean

/

default: false

This autoresponder should run on subscribers added from the API. Any individual API request may still opt to prevent autoresponders from triggering.

This option only applies to autoresponders with trigger=subscription.

trigger_anniversary_custom_field

hash

The Date or Day of Year custom field on which this anniversary autoresponder should trigger.

This option only applies to autoresponders with trigger=anniversary.

trigger_anniversary_shift_number_of_days

integer

The number of days before or after the specified custom field day of year on which this anniversary autoresponder should trigger. If this value is negative, the autoresponder will trigger before the subscriber’s day of year. If this value is positive, the autoresponder will trigger after the subscriber’s day of year.

A value of zero will cause the autoresponder to trigger on the subcsriber’s day of year.

Example: Given that a subscriber’s day of year value is March 15, trigger_anniversary_shift_number_of_days is set to -7, and trigger_anniversary_shift_hour_to_send is set to 13. On March 8 at 1pm (in the organization’s time zone) the autoresponder will trigger.

trigger_anniversary_shift_hour_to_send

integer

The hour of day, in the organization’s time zone, to trigger. This value ranges from 0 (12am) to 23 (11pm).

use_external_delivery_setting

boolean

/

default: true

Use the Mailing List’s Form Delivery Settings for delivery, ignoring the bounce_email_user_id, bounce_email_domain_id, from_name, from_email, virtual_mta_id, url_domain_id, and reply_to fields that are on this Autoresponder.

track_opens

boolean

/

default: true

Track open statistics for this Autoresponder.

track_links

boolean

/

default: true

Track click statistics for this Autoresponder.

content_subject

string

/

required

The subject to use in this Autoresponder’s emails.

content_format

string

/

required

The email format to use in this Autoresponder’s emails.

  • May be: html, text, or both
content_html

string

The HTML content for this Autoresponder.

  • Required if content_format is one of: html or both
content_text

string

The plain-text content for this Autoresponder.

  • Required if content_format is one of: text or both
triggered_on

string

/

read-only

The time at which this Autoresponder was last triggered.

segmentation_criteria_id

integer

/

required

The ID of the segment used to filter messages sent from this Autoresponder.

Only one of segmentation_criteria_id and segmentation_criteria_ad_hoc may be specified.

segmentation_criteria_ad_hoc

array of hashes

/

required

An ad hoc segment specification - see the Segment section of the Campaigns API for more details.

Only one of segmentation_criteria_id and segmentation_criteria_ad_hoc may be specified.

segmentation_criteria_name

string

/

read-only

The name of the segment used to filter messages sent from this Autoresponder.

special_sending_rule_id

integer

/

optional

The ID of the special sending rule used for this Autoresponder.

  • When creating or updating an Autoresponder, only one of special_sending_rule_id and special_sending_rule_name may be present.
special_sending_rule_name

string

/

optional

The name of the special sending rule used for this Autoresponder.

  • When creating or updating an Autoresponder, only one of special_sending_rule_id and special_sending_rule_name may be present.
bounce_email_user_id

integer

The bounce email’s user_id component.

  • Required if use_external_delivery_setting is false
bounce_email_domain_id

integer

The bounce email’s domain_id component.

  • Required if use_external_delivery_setting is false
from_name

string

Emails from this Autoresponder will be sent using this from name.

  • Required if use_external_delivery_setting is false
from_email

string

Emails from this Autoresponder will be sent using this from email.

  • Required if use_external_delivery_setting is false
reply_to

string

The email address that should receive replies for this autoresponder.

  • Must be a valid email address.
virtual_mta_id

integer

Emails from this Autoresponder will be sent using this VirtualMTA.

url_domain_id

integer

Emails from this Autoresponder will be sent using this URL Domain.

trigger_campaign_to_open_id

integer

The ID of the Campaign that when opened will cause this Autoresponder to trigger.

  • Valid only if trigger is: campaign_open
trigger_campaign_to_click_id

integer

The ID of the Campaign that when clicked will cause this Autoresponder to trigger.

  • Valid only if trigger is campaign_click.
trigger_campaign_to_click_on_any_url

boolean

This Autoresponder should respond when clicked on any link in the target Campaign. If this is false, then trigger_campaign_to_click_urls should be provided with a list of links to which to react.

  • Valid only if trigger is campaign_click.
trigger_campaign_to_click_urls

array of strings

The list of URLs contained in the target Campaign’s context to which this Autoresponder should react.

  • Valid only if trigger is campaign_click and trigger_campaign_to_click_on_any_url is false.
trigger_autoresponder_to_open_id

integer

The ID of the Autoresponder that when opened (or not opened) will cause this Autoresponder to trigger.

  • Valid only if trigger is one of: autoresponder_open or autoresponder_nonopen
trigger_autoresponder_to_click_id

integer

The ID of the Autoresponder that when clicked (or not clicked) will cause this Autoresponder to trigger.

  • Valid only if trigger is one of: autoresponder_click or autoresponder_nonclick
trigger_autoresponder_to_click_on_any_url

boolean

This Autoresponder should respond when clicked (or not clicked) on any link in the target Autoresponder. If this is false, then trigger_autoresponder_to_click_urls should be provided with a list of links to which to react.

  • Valid only if trigger is one of: autoresponder_click or autoresponder_nonclick
trigger_autoresponder_to_click_urls

array of strings

The list of URLs contained in the target Autoresponder’s context to which this Autoresponder should react.

  • Valid only if trigger is one of: autoresponder_click or autoresponder_nonclick and trigger_autoresponder_to_click_on_any_url is false.
trigger_autoresponder_to_send_id

integer

The ID of the Autoresponder that when sent will cause this Autoresponder to trigger.

  • Valid only if trigger is: autoresponder_send

Get a list of autoresponders

Get a list of the basic details of all autoresponders of a particular mailing list.

URL

GET /ga/api/v2/mailing_lists/:mailing_list_id/autoresponders

Response

The response will be a JSON array where each element contains the Autoresponder Attributes.

Example

GET /ga/api/v2/mailing_lists/1/autoresponders

HTTP/1.1 200 OK

{
  "success": true,
  "data": [
    {
      "bounce_email_domain_id": null,
      "bounce_email_user_id": null,
      "delay": "immediately",
      "delay_amount": 0,
      "delay_time": 0,
      "delay_unit": null,
      "from_email": null,
      "from_name": null,
      "id": 1,
      "mailing_list_id": 1,
      "name": "Autoresponder A",
      "paused": false,
      "paused_at": null,
      "reply_to": null,
      "segmentation_criteria_id": 1,
      "track_links": true,
      "track_opens": true,
      "trigger": "subscription",
      "trigger_autoresponder_to_click_id": null,
      "trigger_autoresponder_to_click_on_any_url": null,
      "trigger_autoresponder_to_click_urls": null,
      "trigger_autoresponder_to_open_id": null,
      "trigger_autoresponder_to_send_id": null,
      "trigger_campaign_to_click_id": null,
      "trigger_campaign_to_click_on_any_url": null,
      "trigger_campaign_to_click_urls": null,
      "trigger_campaign_to_open_id": null,
      "trigger_include_subscribers_from_import": false,
      "trigger_run_on_api": false,
      "triggered_on": null,
      "url_domain_id": null,
      "use_external_delivery_setting": true,
      "virtual_mta_id": null,
      "special_sending_rule_id": null,
      "special_sending_rule_name": null,
      "content_subject": "test",
      "content_format": "both",
      "content_html": "",
      "content_text": "",
      "segmentation_criteria_name": "Named Segment #127"
    },
    {
      "bounce_email_domain_id": null,
      "bounce_email_user_id": null,
      "delay": "immediately",
      "delay_amount": 0,
      "delay_time": 0,
      "delay_unit": null,
      "from_email": null,
      "from_name": null,
      "id": 2,
      "mailing_list_id": 1,
      "name": "Autoresponder B",
      "paused": false,
      "paused_at": null,
      "reply_to": null,
      "segmentation_criteria_id": 2,
      "track_links": true,
      "track_opens": true,
      "trigger": "subscription",
      "trigger_autoresponder_to_click_id": null,
      "trigger_autoresponder_to_click_on_any_url": null,
      "trigger_autoresponder_to_click_urls": null,
      "trigger_autoresponder_to_open_id": null,
      "trigger_autoresponder_to_send_id": null,
      "trigger_campaign_to_click_id": null,
      "trigger_campaign_to_click_on_any_url": null,
      "trigger_campaign_to_click_urls": null,
      "trigger_campaign_to_open_id": null,
      "trigger_include_subscribers_from_import": false,
      "trigger_run_on_api": false,
      "triggered_on": null,
      "url_domain_id": null,
      "use_external_delivery_setting": true,
      "virtual_mta_id": null,
      "special_sending_rule_id": null,
      "special_sending_rule_name": null,
      "content_subject": "test",
      "content_format": "both",
      "content_html": "",
      "content_text": "",
      "segmentation_criteria_name": "Named Segment #128"
    },
    {
      "bounce_email_domain_id": 8,
      "bounce_email_user_id": 14,
      "delay": "immediately",
      "delay_amount": 0,
      "delay_time": 0,
      "delay_unit": null,
      "from_email": "[email protected]",
      "from_name": "Bob Example",
      "id": 3,
      "mailing_list_id": 1,
      "name": "Autoresponder C",
      "paused": false,
      "paused_at": null,
      "reply_to": "[email protected]",
      "segmentation_criteria_id": 3,
      "track_links": true,
      "track_opens": true,
      "trigger": "subscription",
      "trigger_autoresponder_to_click_id": null,
      "trigger_autoresponder_to_click_on_any_url": null,
      "trigger_autoresponder_to_click_urls": null,
      "trigger_autoresponder_to_open_id": null,
      "trigger_autoresponder_to_send_id": null,
      "trigger_campaign_to_click_id": null,
      "trigger_campaign_to_click_on_any_url": null,
      "trigger_campaign_to_click_urls": null,
      "trigger_campaign_to_open_id": null,
      "trigger_include_subscribers_from_import": false,
      "trigger_run_on_api": false,
      "triggered_on": null,
      "url_domain_id": 91,
      "use_external_delivery_setting": false,
      "virtual_mta_id": 12,
      "special_sending_rule_id": null,
      "special_sending_rule_name": null,
      "content_subject": "test",
      "content_format": "both",
      "content_html": "",
      "content_text": "",
      "segmentation_criteria_name": "Named Segment #129"
    }
  ],
  "error_code": null,
  "error_message": null
}

Create a new autoresponder

Create a new autoresponder on the specified mailing list.

URL

POST /ga/api/v2/mailing_lists/:mailing_list_id/autoresponders

Request Parameters

The request body should be a JSON hash of Autoresponder Attributes.

Response

The response will be a JSON hash of Autoresponder Attributes.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

> POST /ga/api/mailing_lists/1/autoresponders HTTP/1.1
> Authorization: Basic MToxNmRjYjllYmM1MzE1M2Q3YWViOTQ3YmE0MGE3NDVkMzc4N2ViYWJj
> Accept: application/json
> Content-Type: application/json

{
  "autoresponder": {
    "bounce_email_domain_id": 1,
    "bounce_email_user_id": 1,
    "delay": "immediately",
    "delay_amount": 0,
    "delay_time": 0,
    "delay_unit": null,
    "from_email": "[email protected]",
    "from_name": "Bob Example",
    "name": "Autoresponder 2",
    "paused": false,
    "paused_at": null,
    "reply_to": null,
    "segmentation_criteria_id": 1,
    "track_links": true,
    "track_opens": true,
    "trigger": "subscription",
    "trigger_campaign_to_open_id": null,
    "trigger_include_subscribers_from_import": false,
    "trigger_run_on_api": false,
    "triggered_on": "2014-06-30",
    "url_domain_id": 1,
    "use_external_delivery_setting": true,
    "virtual_mta_id": 0,
    "content_format": "html",
    "content_subject": "Welcome to our mailing list!",
    "content_html": "<p>Welcome!</p>",
    "special_sending_rule_id":123,
    "special_sending_rule_name":"Customize Content"
  }
}

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "d5361297bdcff3a922bfe56d5f2398ad"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: ["request_method=POST; path=/", "_session_id=4851f080c4908bd8fbe3809de3146c8d; path=/; HttpOnly"]
< X-Request-Id: bdc5494afb378e0e6aac27adf21ffd9f
< X-Runtime: 0.171395
< Connection: close
< Server: thin

{
  "success": true,
  "data": {
    "bounce_email_domain_id": null,
    "bounce_email_user_id": null,
    "delay": "immediately",
    "delay_amount": 0,
    "delay_time": 0,
    "delay_unit": null,
    "from_email": null,
    "from_name": null,
    "id": 3,
    "mailing_list_id": 1,
    "name": "Autoresponder 2",
    "paused": false,
    "paused_at": null,
    "reply_to": null,
    "segmentation_criteria_id": 1,
    "track_links": true,
    "track_opens": true,
    "trigger": "subscription",
    "trigger_autoresponder_to_open_id": null,
    "trigger_campaign_to_open_id": null,
    "trigger_include_subscribers_from_import": false,
    "trigger_run_on_api": false,
    "triggered_on": null,
    "url_domain_id": null,
    "use_external_delivery_setting": true,
    "virtual_mta_id": null,
    "special_sending_rule_id":92,
    "special_sending_rule_name":"Customize Content",
    "content_subject": "Welcome to our mailing list!",
    "content_format": "html",
    "content_html": "<h1>Welcome!</h1>",
    "content_text": "",
    "segmentation_criteria_name": "Named Segment #1"
  },
  "error_code": null,
  "error_message": null
}

Update an existing autoresponder

Update an existing autoresponder.

URL

PUT /ga/api/v2/mailing_lists/:mailing_list_id/autoresponders/:id

Request Parameters

The request body should be a JSON hash of Autoresponder Attributes.

Response

The response will be a JSON hash of Autoresponder Attributes.

Example

Note that the JSON response will not be “pretty formatted” as it is below.

> PUT /ga/api/mailing_lists/1/autoresponders/1 HTTP/1.1
> Authorization: Basic MToxNmRjYjllYmM1MzE1M2Q3YWViOTQ3YmE0MGE3NDVkMzc4N2ViYWJj
> Accept: application/json
> Content-Type: application/json

{
  "autoresponder": {
    "from_email": "[email protected]",
    "content_text": "foo bar"
  }
}

< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< ETag: "b85e60d89386b93deb04dca295faed38"
< Cache-Control: max-age=0, private, must-revalidate
< Set-Cookie: ["request_method=PUT; path=/", "_session_id=b8f57f23aeed1f8789cf890813e6805c; path=/; HttpOnly"]
< X-Request-Id: a8569a929868290a1c713285ebe1731a
< X-Runtime: 0.108229
< Connection: close
< Server: thin

{
  "success": true,
  "data": {
    "bounce_email_domain_id": null,
    "bounce_email_user_id": null,
    "delay": "immediately",
    "delay_amount": 0,
    "delay_time": 0,
    "delay_unit": null,
    "from_email": null,
    "from_name": null,
    "id": 1,
    "mailing_list_id": 1,
    "name": "Subscription Autoresponder #1",
    "paused": true,
    "paused_at": null,
    "reply_to": null,
    "segmentation_criteria_id": 1,
    "track_links": true,
    "track_opens": true,
    "trigger": "subscription",
    "trigger_autoresponder_to_open_id": null,
    "trigger_campaign_to_open_id": null,
    "trigger_include_subscribers_from_import": true,
    "trigger_run_on_api": true,
    "triggered_on": null,
    "url_domain_id": null,
    "use_external_delivery_setting": true,
    "virtual_mta_id": null,
    "special_sending_rule_id": null,
    "special_sending_rule_name": null,
    "content_subject": "Welcome to my list!",
    "content_format": "both",
    "content_html": "<!DOCTYPE html>\r\n<html>\r\n<head>\r\n</head>\r\n<body>\r\n<p>I'm so pleased you could join us.</p>\r\n</body>\r\n</html>",
    "content_text": "foo bar",
    "segmentation_criteria_name": "Named Segment #1"
  },
  "error_code": null,
  "error_message": null
}

Get statistics for an autoresponder

URL

GET /ga/api/v2/mailing_lists/:mailing_list_id/autoresponders/:id/statistics
GET /ga/api/v2/mailing_lists/:mailing_list_id/autoresponders/:id/statistics?start_date=20140302&end_date=20140401

Request Parameters

mailing_list_id

integer

The id of the mailing list the subscribers are on. This can be found on the mailing list’s page under the Admin section

id

integer

The id of the autoresponder

start_date

integer

The earliest date (as an integer) that email was sent for the requested statistics. The result will include statistics for emails sent on this date. This can be blank.

end_date

integer

The latest date (as an integer) that email was sent for the requested statistics. The result will include statistics for emails sent on this date. This can be blank.

Response

sent_text

integer

Number of recipients that were sent a text-only message.

sent_html

integer

Number of recipients that were sent a html-only message.

sent_multipart

integer

Number of recipients that were sent a multipart message.

messages_sent

integer

Total number of recipients.

messages_html

integer

Number of recipients that received either an HTML or multipart message.

messages_text

integer

Number of recipients that received a text-only message.

bounces_total

integer

Total number of bounces received.

bounces_unique

integer

Unique (by subscriber) bounces received.

bounces_unique_hard

integer

Number of unique (by subscriber) bounces where bounce_type is hard.

bounces_unique_soft

integer

Number of unique (by subscriber) bounces where bounce_type is soft.

bounces_unique_other

integer

Number of unique (by subscriber) bounces where bounce_type is other.

bounces_unique_local

integer

Number of unique (by subscriber) bounces that were local.

bounces_unique_remote

integer

Number of unique (by subscriber) bounces that were remote.

bounces_status_updated

integer

Number of recipients where status was updated to status bounce.

bounces_unique_by_code

hash

Number of unique (by subscriber) bounces for each bounce code. The keys in the included hash are the bounce code.

bounced

integer

Deprecated: Unique (by subscriber) bounces received. This is just another name for bounces_unique.

duplicate_bounces

integer

Number of non-unique bounces.

unbounced

integer

Number of messages that were sent that have not bounced.

bounce_rate

float

Floating point value indicating the unique bounce rate for this autoresponder. This value ranges from 0.0 to 1.0.

bounce_rate_hard

float

The ratio of the unique bounces that were hard bounces. This value ranges from 0.0 to 1.0.

bounce_rate_soft

float

The ratio of the unique bounces that were soft bounces. This value ranges from 0.0 to 1.0.

bounce_rate_other

float

The ratio of the unique bounces that were other bounces. This value ranges from 0.0 to 1.0.

bounce_local_rate

float

The ratio of the unique bounces that were local bounces. This value ranges from 0.0 to 1.0.

clicks_total

integer

Number of total clicks.

clicks_unique

integer

Number of unique clicks (unique by subscriber).

clicks_unique_by_link

integer

Deprecated: Number of unique clicks (unique by subscriber/link) – this value does not carry much meaning.

duplicate_clicks

integer

Number of non-unique clicks.

click_rate

float

The ratio of messages that were accepted and have been clicked. This value ranges from 0.0 to 1.0.

click_to_open_rate

float

The ratio of messages that were opened that have been clicked. This value ranges from 0.0 to 1.0.

unclicked

integer

Number of messages that were accepted by the remote server but have not been clicked.

opens_total

integer

Number of total opens

opens_unique

integer

Number of unique opens (unique by subscriber)

open_rate

float

Ratio of messages that were accepted that have been opened. This value ranges from 0.0 to 1.0.

open_ratio

float

Average number of times each opened message has been opened (opens_total / opens_unique). This value ranges from 0.0 to 1.0.

unopened

integer

Number of messages that were accepted and have not been opened.

duplicate_opens

integer

Number of non-unique opens.

scomps_total

integer

Number of spam complaints

scomps_unique

integer

Number of unique spam complaints (unique by subscriber).

scomps_status_updated

integer

Number of recipients where the status was updated to status scomp.

duplicate_scomps

integer

Number of non-unique spam complaints.

scomp_rate

float

The ratio of messages that were accepted and complained. This value ranges from 0.0 to 1.0.

We recommend using this statistic with great caution. Please read this article on why using a per-ISP complaint ratio is often better: https://www.greenarrowemail.com/blog/the-most-misunderstood-statistic-in-email-delivery

unsubs_total

integer

Number of total unsubscribes

unsubs_unique

integer

Number of unique unsubscribes (unique by subscriber)

unsubs_status_updated

integer

Number of recipients where the status was updated to status unsubscribed.

duplicate_unsubs

integer

Number of non-unique unsubscribes.

unsub_rate

float

The ratio of messages that were accepted and unsubscribed. This value ranges from 0.0 to 1.0.

skips_error

integer

Number of messages that were skipped due to a Special Sending Rule error.

skips_request

integer

Number of messages that were skipped due to a Special Sending Rule request.

total_messages

integer

Total number of messages injected for this autoresponder.

total_success

integer

Number of messages that were successfully delivered to the remote server.

total_failure

integer

Number of messages ended due to SMTP conversation failures.

total_failure_toolong

integer

Number of messages ended due to being in the queue too long.

accepted

integer

Total number of messages that were accepted by the remote server.

accepted_rate

float

Ratio of messages that were attempted and accepted (accepted / messages_sent). This value ranges from 0.0 to 1.0.

in_queue

integer

Number of messages that are currently in GreenArrow Engine’s delivery queue.

in_queue_rate

float

Ratio of the total number of messages that have been handed off to GreenArrow Engine and are still in queue. This value ranges from 0.0 to 1.0.

max_unique_activities

integer

The max value of opens_unique, clicks_unique, unsubs_unique, and scomps_unique.

Example

> GET /ga/api/v2/mailing_lists/1/autoresponders/1/statistics HTTP/1.1
> Authorization: Basic MTo1ZTk2NDY1Yzg4M2YzMzA5ZjAxMDVhMmUxMDc2NjMyYjY4N2U2MWQy
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8r zlib/1.2.5
> Host: greenarrow-studio.dev
> Accept: */*
>
< HTTP/1.1 200 OK
< Cache-Control: no-cache, no-store, max-age=0, must-revalidate
< Pragma: no-cache
< Expires: Fri, 01 Jan 1990 00:00:00 GMT
< Content-Type: application/json; charset=utf-8
< X-UA-Compatible: IE=Edge
< Set-Cookie: _session_id=458055a23f26f844e74f8cd7300f6445; path=/; HttpOnly
< X-Request-Id: f6e40d578ed1d9c418cca45e1b7fe532
< X-Runtime: 0.025540
< Connection: close

{
   "success":true,
   "data":{
      "sent_text":3,
      "sent_html":137,
      "sent_multipart":137,
      "bounces_total":2,
      "bounces_unique":2,
      "bounces_unique_hard":2,
      "bounces_unique_soft":0,
      "bounces_unique_other":0,
      "bounces_unique_local":0,
      "bounces_unique_remote":2,
      "clicks_total":22,
      "clicks_unique":22,
      "clicks_unique_by_link":22,
      "opens_total":299,
      "opens_unique":101,
      "scomps_total":2,
      "scomps_unique":2,
      "scomps_status_updated":2,
      "unsubs_total":30,
      "unsubs_unique":23,
      "unsubs_status_updated":0,
      "bounces_status_updated":0,
      "total_messages":0,
      "total_success":0,
      "total_failure":0,
      "total_failure_toolong":0,
      "bounces_unique_by_code":{
         "200":1,
         "209":1
      },
      "messages_sent":277,
      "messages_html":274,
      "messages_text":3,
      "accepted":275,
      "accepted_rate":0.9927797833935018,
      "in_queue":0,
      "in_queue_rate":0.0,
      "max_unique_activities":101,
      "open_rate":0.36727272727272725,
      "open_ratio":2.9603960396039604,
      "unopened":174,
      "duplicate_opens":198,
      "duplicate_clicks":0,
      "click_rate":0.08,
      "click_to_open_rate":0.21782178217821782,
      "unclicked":253,
      "bounced":2,
      "duplicate_bounces":0,
      "unbounced":275,
      "bounce_rate":0.007220216606498195,
      "bounce_rate_hard":1.0,
      "bounce_rate_soft":0.0,
      "bounce_rate_other":0.0,
      "bounce_local_rate":0.0,
      "duplicate_scomps":0,
      "scomp_rate":0.0,
      "duplicate_unsubs":7,
      "unsub_rate":0.08363636363636363,
      "skips_error":2,
      "skips_request":17
   },
   "error_code":null,
   "error_message":null
}


Copyright © 2012–2019 GreenArrow Email