GreenArrow Email Software Documentation

Mailing Lists API

Get a list of mailing lists

Get a list of the basic details of all mailing lists in GreenArrow Studio.

URL

GET /ga/api/v2/mailing_lists

Request Parameters

This API method does not require any additional parameters.

Response

The response will be a JSON array where each element contains the following keys.

id

integer

The id of the mailing list

name

string

The name of the mailing list

d_from_email

string

The default From email for campaigns from this mailing list

d_from_name

string

The default From name for campaigns from this mailing list

d_reply_to

string

The default Reply-To email address for campaigns from this mailing list

d_virtual_mta

string

The name of the default Virtual MTA for campaigns from this mailing list

d_url_domain

string

The default URL Domain for campaigns from this mailing list

d_speed

integer

The default speed for campaigns from this mailing list

d_sender_email

string

The default Sender email address for campaigns from this mailing list

d_bounce_email

string

The default Bounce email address for campaigns from this mailing list.

d_seed_lists

array of hashes

The default seed lists for campaigns from this mailing list. This is an array of hashes with the id and name keys.

d_autowinner_enabled

boolean

The default setting for automatic winner selection on new campaigns

d_autowinner_percentage

string

The default percentage that will be sent for the split-test portion of the campaign (Note: This value is returned as a string to prevent floating-point conversion errors)

d_autowinner_delay_amount

integer

The default number of units of time that the campaign will wait before finishing after a split-test.

d_autowinner_delay_unit

string

The default unit used in calculating the delay duration.

d_autowinner_metric

string

The default metric used to decide the winner. See the “Automatic Winner Selection Metrics” table for more information.

has_format

boolean

True if this mailing list uses the email_format field.

has_confirmed

boolean

True if this mailing list uses the confirmed field.

custom_headers_enabled

boolean

True if this mailing list uses custom headers. If true, custom_headers must be set.

custom_headers

string

The content of the custom headers that will be added to every email sent to this mailing list.

primary_key_custom_field_id

integer

The custom field id of the primary key for the mailing list. If this value is null, then the primary key is the subscriber’s email address.

preview_custom_field_data

hash

The custom field data, see example below.

is_remote_list

boolean

True if this mailing list uses a remote database to retrieve recipient data for campaigns.

database_connection_id

integer

The primary key of the database connection to use on this mailing list.

database_connection_name

integer

The name of the database connection to use on this mailing list.

  1. Note: This value is returned as a string to prevent floating-point conversion errors. You may send this value as an Integer, Float or String. Posting a value with more than two decimals will cause a validation error. Be careful because IEEE floating point can not exactly represent some decimal values. For example 94.85 is represented as 94.85000000000001 which will cause a validation error if used here. You may want to print to a string using two decimal places of precision.

Preview Custom Field Data

The preview_custom_field_data key is filled with a hash.

{
  "Custom Field Name": {
    "name": "Custom Field Name",
    "type": "text",
    "value": "Bob Example"
  },
  "Next Custom Field": {
    "name": "Next Custom Field",
    "type": "select_multiple_checkboxes",
    "value": [ "Red", "Blue" ]
  }
}

Custom fields which have Preview Custom Field Data values and are not specified in the preview_custom_field_data list, will remain with the same values. In other words: the custom fields provided in preview_custom_field_data are merged in with the existing Preview Custom Field Data custom fields.

Example

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

> GET /ga/api/v2/mailing_lists 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

{
    "data": [
        {
            "d_bounce_email": null,
            "d_bounce_email_id": "",
            "d_from_email": "[email protected]",
            "d_from_name": "Joe Example",
            "d_reply_to": "",
            "d_sender_email": "",
            "d_speed": 0,
            "d_url_domain": "staging.example.com",
            "d_url_domain_id": 1,
            "d_virtual_mta": "System Default Route",
            "d_virtual_mta_id": 0,
            "d_autowinner_enabled": false,
            "d_autowinner_percentage": null,
            "d_autowinner_delay_amount": null,
            "d_autowinner_delay_unit": null,
            "d_autowinner_metric": null,
            "has_format": false,
            "has_confirmed": false,
            "id": 2,
            "name": "Daily News Letter",
            "custom_headers_enabled": true,
            "custom_headers": "X-Company: Acme\n",
            "primary_key_custom_field_id": null,
            "preview_custom_field_data": {
              "First Name": { "name": "First Name", "type": "text", "value": "Bob Example" }
            }
        },
        {
            "d_bounce_email": "[email protected]",
            "d_bounce_email_id": "[email protected]",
            "d_from_email": "[email protected]",
            "d_from_name": "Bob Staging",
            "d_reply_to": "",
            "d_sender_email": "",
            "d_speed": 0,
            "d_url_domain": "staging.example.com",
            "d_url_domain_id": 1,
            "d_virtual_mta": "System Default Route",
            "d_virtual_mta_id": 0,
            "d_autowinner_enabled": true,
            "d_autowinner_percentage": "25.0",
            "d_autowinner_delay_amount": 10,
            "d_autowinner_delay_unit": "hours",
            "d_autowinner_metric": "opens_unique",
            "has_format": false,
            "has_confirmed": false,
            "id": 12,
            "name": "Weather Forecasts",
            "custom_headers_enabled": false,
            "custom_headers": "",
            "primary_key_custom_field_id": 112391
        }
    ],
    "error_code": null,
    "error_message": null,
    "success": true
}

Create a new mailing list

URL

POST /ga/api/v2/mailing_lists

Request Parameters

This API method does not require any additional parameters.

Request Payload

The POST request should have a JSON document in its payload with the following keys.

mailing_list

hash


name

string / required

The name of the mailing list

d_from_email

string / default: null

The default From email for campaigns from this mailing list

d_from_name

string / default: null

The default From name for campaigns from this mailing list

d_reply_to

string / default: null

The default Reply-To email address for campaigns from this mailing list

d_virtual_mta

string / default: null

The name of the default Virtual MTA for campaigns from this mailing list. The special name of “System Default Route” may be used to select the system-wide default Virtual MTA

d_url_domain

string / default: null

The default URL Domain for campaigns from this mailing list

d_speed

integer / default: null

The default speed for campaigns from this mailing list

d_sender_email

string / default: null

The default Sender email address for campaigns from this mailing list

d_bounce_email

string / default: null

The default bounce email address for campaigns from this mailing list.

d_seed_list_ids

array of integers / default: []

The default seed lists for campaigns from this mailing list. This is an array of integers that represent the IDs of the seed lists to use. Only d_seed_list_ids or d_seed_list_names should be specified.

d_seed_list_names

array of strings / default: []

The default seed lists for campaigns from this mailing list. This is an array of strings that represent the names of the seed lists to use. Only d_seed_list_ids or d_seed_list_names should be specified.

d_autowinner_enabled

boolean / default: false

The default setting for automatic winner selection on new campaigns

d_autowinner_percentage

string

The default percentage that will be sent for the split-test portion of the campaign (See 1 below). Required if d_autowinner_enabled is true.

d_autowinner_delay_amount

integer

The default number of units of time that the campaign will wait before finishing after a split-test. Required if d_autowinner_enabled is true.

d_autowinner_delay_unit

string

The default unit used in calculating the delay duration. Required if d_autowinner_enabled is true.

d_autowinner_metric

string

The default metric used to decide the winner. See the “Automatic Winner Selection Metrics” table for more information. Required if d_autowinner_enabled is true.

has_format

boolean / default: false

True if this mailing list uses the email_format field.

has_confirmed

boolean / default: false

True if this mailing list uses the confirmed field.

custom_headers_enabled

boolean / default: false

True if this mailing list uses custom headers. If true, custom_headers must be set.

custom_headers

string / default: ""

The content of the custom headers that will be added to every email sent to this mailing list.

is_remote_list

boolean / default: false

True if this mailing list uses a remote database to retrieve recipient data for campaigns (See 2 below).

database_connection_id

integer

The primary key of the database connection to use on this mailing list (See 2 below).

database_connection_name

string

The name of the database connection to use on this mailing list (See 2 below).

  1. Note: This value is returned as a string to prevent floating-point conversion errors. You may send this value as an Integer, Float or String. Posting a value with more than two decimals will cause a validation error. Be careful because IEEE floating point can not exactly represent some decimal values. For example 94.85 is represented as 94.85000000000001 which will cause a validation error if used here. You may want to print to a string using two decimal places of precision.
  2. Remote Lists may only be created on the System Organization. Exactly one of database_connection_id and database_connection_name may be provided. The database connection must be previously set up in GreenArrow Engine.

Response

A successful response will return the mailing list record using the format described in the “Get a list of mailing lists” section of the API.

A failure will return a standard error response with an explanation of what went wrong.

  • Only one of d_seed_list_ids and d_seed_list_names should be present in a single request.

Example

> POST /ga/api/v2/mailing_lists 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: */*
> content-type: application/json
> Content-Length: 309

{
    "mailing_list": {
        "d_bounce_email": null,
        "d_from_email": "[email protected]",
        "d_from_name": "Joe Example",
        "d_reply_to": "",
        "d_sender_email": "",
        "d_speed": 0,
        "d_seed_list_names": [ "Seed List" ],
        "d_url_domain": "staging.example.com",
        "d_virtual_mta": "System Default Route",
        "d_autowinner_enabled": true,
        "d_autowinner_percentage": "25.0",
        "d_autowinner_delay_amount": 10,
        "d_autowinner_delay_unit": "hours",
        "d_autowinner_metric": "opens_unique",
        "has_format": false,
        "has_confirmed": false,
        "name": "Daily News Letter"
    }
}

< 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=397c15499b2ee6e225accb1f75745129; path=/; HttpOnly
< X-Request-Id: 6944382a9a981c44a26f5aa6b318efb8
< X-Runtime: 0.027678
< Connection: close

{
    "data": {
        "d_bounce_email": null,
        "d_bounce_email_id": null,
        "d_from_email": "[email protected]",
        "d_from_name": "Joe Example",
        "d_reply_to": "",
        "d_sender_email": "",
        "d_speed": 0,
        "d_seed_lists": [ { "id": 1, "name": "Seed List" } ],
        "d_url_domain": "staging.example.com",
        "d_url_domain_id": 2,
        "d_virtual_mta": "System Default Route",
        "d_virtual_mta_id": 0,
        "d_autowinner_enabled": true,
        "d_autowinner_percentage": "25.0",
        "d_autowinner_delay_amount": 10,
        "d_autowinner_delay_unit": "hours",
        "d_autowinner_metric": "opens_unique",
        "has_format": false,
        "has_confirmed": false,
        "id": 22,
        "name": "Daily News Letter",
        "custom_headers_enabled": false,
        "custom_headers": "",
        "primary_key_custom_field_id": null
    },
    "error_code": null,
    "error_message": null,
    "success": true
}

Update an existing mailing list

URL

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

Request Parameters

mailing_list_id

integer

The id of the mailing list to update

Request Payload

The PUT request should have a JSON document in its payload with all of the following keys.

name

string

The name of the mailing list

d_from_email

string

The default From email for campaigns from this mailing list

d_from_name

string

The default From name for campaigns from this mailing list

d_reply_to

string

The default Reply-To email address for campaigns from this mailing list

d_virtual_mta

string

The name of the default Virtual MTA for campaigns from this mailing list

d_url_domain

string

The default URL Domain for campaigns from this mailing list

d_speed

integer

The default speed for campaigns from this mailing list

d_sender_email

string

The default Sender email address for campaigns from this mailing list

d_bounce_email

string

The default Bounce email address for campaigns from this mailing list.

d_seed_list_ids (array of integers:

The default seed lists for campaigns from this mailing list. This is an array of integers that represent the IDs of the seed lists to use.

d_seed_list_names

array of strings

The default seed lists for campaigns from this mailing list. This is an array of strings that represent the names of the seed lists to use.

d_autowinner_enabled

boolean

The default setting for automatic winner selection on new campaigns

d_autowinner_percentage

string

The default percentage that will be sent for the split-test portion of the campaign

d_autowinner_delay_amount

integer

The default number of units of time that the campaign will wait before finishing after a split-test.

d_autowinner_delay_unit

string

The default unit used in calculating the delay duration.

d_autowinner_metric

string

The default metric used to decide the winner. See the “Automatic Winner Selection Metrics” table for more information.

has_format

boolean

True if this mailing list uses the email_format field.

has_confirmed

boolean

True if this mailing list uses the confirmed field.

custom_headers_enabled

boolean

True if this mailing list uses custom headers. If true, custom_headers must be set.

custom_headers

string

The content of the custom headers that will be added to every email sent to this mailing list.

primary_key_custom_field_id

integer

The custom field to use as this mailing list’s primary key. If this is null, then the subscriber’s email address will be the primary key.

preview_custom_field_data

hash

The custom field data, a hash that maps custom field names to values.

database_connection_id

integer

The primary key of the database connection to use on this mailing list (See 2 below).

database_connection_name

integer

The name of the database connection to use on this mailing list (See 2 below).

  1. The d_autowinner_percentage value is returned as a string to prevent floating-point conversion errors. You may send this value as an Integer, Float or String. Posting a value with more than 2 decimals will cause a validation error. Be careful because IEEE floating point can not exactly represent some decimal values. For example 94.85 is represented as 94.85000000000001 which will cause a validation error if used here. You may want to print to a string using two decimal places of precision.
  2. Only one of d_seed_list_ids and d_seed_list_names should be present in a single request.
  3. Only one of database_connection_id and database_connection_name should be present in a single request. These fields may only be present if the mailing list was created with is_remote_list enabled.

Response

A successful response will return the subscriber record using the format described in the “Get subscriber details” section of the API.

A failure will return a standard error response with an explanation of what went wrong.

Example

> PUT /ga/api/v2/mailing_lists/22 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: */*
> content-type: application/json
> Content-Length: 309

{
    "mailing_list": {
        "d_bounce_email": null,
        "d_from_email": "[email protected]",
        "d_from_name": "Joe Example",
        "d_reply_to": "",
        "d_sender_email": "",
        "d_speed": 0,
        "d_url_domain": "staging.example.com",
        "d_virtual_mta": "System Default Route",
        "d_autowinner_enabled": true,
        "d_autowinner_percentage": "25.0",
        "d_autowinner_delay_amount": 10,
        "d_autowinner_delay_unit": "hours",
        "d_autowinner_metric": "opens_unique",
        "has_format": false,
        "has_confirmed": false,
        "name": "Renamed Daily News Letter",
        "custom_headers_enabled": false,
        "custom_headers": "",
        "primary_key_custom_field_id": null
    }
}

< 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=397c15499b2ee6e225accb1f75745129; path=/; HttpOnly
< X-Request-Id: 6944382a9a981c44a26f5aa6b318efb8
< X-Runtime: 0.027678
< Connection: close

{
    "data": {
        "d_bounce_email": null,
        "d_bounce_email_id": null,
        "d_from_email": "[email protected]",
        "d_from_name": "Joe Example",
        "d_reply_to": "",
        "d_sender_email": "",
        "d_speed": 0,
        "d_url_domain": "staging.example.com",
        "d_url_domain_id": 2,
        "d_virtual_mta": "System Default Route",
        "d_virtual_mta_id": 0,
        "d_autowinner_enabled": true,
        "d_autowinner_percentage": "25.0",
        "d_autowinner_delay_amount": 10,
        "d_autowinner_delay_unit": "hours",
        "d_autowinner_metric": "opens_unique",
        "has_format": false,
        "has_confirmed": false,
        "id": 22,
        "name": "Renamed Daily News Letter",
        "custom_headers_enabled": false,
        "custom_headers": "",
        "primary_key_custom_field_id": null
    },
    "error_code": null,
    "error_message": null,
    "success": true
}

Deleting a mailing list

Deleting a mailing list is a two-step process:

  1. Request a Delete Confirmation Code. This will generate a confirmation code that will be valid for 2 minutes.
  2. Send the confirmation code back to the server.

We do this because deleting a mailing list is what we consider to be a major event. The following happens when a mailing list is deleted:

  1. All subscribers are deleted.
  2. All active/scheduled subscriber imports and exports are cancelled.
  3. All active/scheduled campaigns are cancelled.
  4. The mailing list’s database entry is marked as deleted.

From that point forward, the mailing list will no longer appear in the user interface.

URL

To request the confirmation code:

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

To confirm the deletion and start the deletion process:

DELETE /ga/api/v2/mailing_lists/:mailing_list_id/confirmed/:delete_confirmation_code

Response (Request Confirmation Code)

delete_confirmation_code

The token to send back to the server to confirm deletion of the specified mailing list.

delete_confirmation_expires_at

The time at which the included token will no longer be valid.

Example

> GET /ga/api/mailing_lists/3/delete_confirmation_code HTTP/1.1
> Authorization: Basic MTpjMjBmMWMyODUwM2M5ODg2N2YwZDRjYWQ3NGYyMWI4NzU5ODMzYTAz
> Accept: application/json
> Content-Type: application/json

< Date: Tue, 20 Jan 2015 14:15:46 GMT
< Server: Apache/2.2.27 (Unix) mod_ssl/2.2.27 OpenSSL/1.0.1e-fips PHP/5.3.28 Phusion_Passenger/4.0.45
< X-UA-Compatible: IE=Edge,chrome=1
< ETag: "695e7fac5af2c12993874f8e798a127a"
< Cache-Control: must-revalidate, private, max-age=0
< X-Request-Id: efc60ffbc114662efdae67ff6f7f4e72
< X-Runtime: 0.084875
< X-Rack-Cache: miss
< X-Powered-By: Phusion Passenger 4.0.45
< Set-Cookie: _session_id=4c395b61027d76f25f469bedf53c6f5d; path=/; HttpOnly
< Status: 200 OK
< Transfer-Encoding: chunked
< Content-Type: application/json; charset=utf-8

{
  "success": true,
  "data": {
    "delete_confirmation_code": "889d6ede39689b0f25e41d8cd4441f7d18082c79:1421871666",
    "delete_confirmation_expires_at": "2015-01-20T14:17:46Z"
  },
  "error_code": null,
  "error_message": null
}

Response (Reply with Confirmation Code, Delete Mailing List)

An empty successful response to this request indicates that the mailing list has been marked as deleted and the data cleanup listed above has been done.

Example

> DELETE /ga/api/mailing_lists/3/confirmed/889d6ede39689b0f25e41d8cd4441f7d18082c79:1421871666 HTTP/1.1
> Authorization: Basic MTpjMjBmMWMyODUwM2M5ODg2N2YwZDRjYWQ3NGYyMWI4NzU5ODMzYTAz
> Accept: application/json
> Content-Type: application/json

< Date: Tue, 20 Jan 2015 14:16:00 GMT
< Server: Apache/2.2.27 (Unix) mod_ssl/2.2.27 OpenSSL/1.0.1e-fips PHP/5.3.28 Phusion_Passenger/4.0.45
< X-UA-Compatible: IE=Edge,chrome=1
< ETag: "f744395dc73a323ce47b552d60a1c6cb"
< Cache-Control: max-age=0, private, must-revalidate
< X-Request-Id: 75d99d41a3063d411b23cd751c9bf4cd
< X-Runtime: 0.096435
< X-Rack-Cache: invalidate, pass
< X-Powered-By: Phusion Passenger 4.0.45
< Set-Cookie: _session_id=ae243b2ca548b6e3e1c57967bc33e44f; path=/; HttpOnly
< Status: 200 OK
< Transfer-Encoding: chunked
< Content-Type: application/json; charset=utf-8

{
  "success": true,
  "data": null,
  "error_code": null,
  "error_message": null
}

Campaign Statistics

Retrieve aggregated campaign statistics for this mailing list.

If provided, the campaigns included in this aggregation can be filtered based upon when they started sending.

URL

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

Request Parameters

started_at__start

timestamp

When this field is provided, only campaigns that started on or after the specified time will be included in the results.

When this is not provided, the results will include campaigns dating back to when the mailing list was created.

started_at__end

timestamp

When this field is provided, only campaigns that started before the specified time will be included in the results.

When this is not provided, the results will include campaigns up to the current time.

Response

aggregated_campaign_statistics

hash


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, as shown in the Studio Statistics page. Suppressed addresses and seed lists addresses are not included.

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’ (See 1 below).

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 campaign. 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 – see the Links endpoint below.

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’ (See 1 below).

duplicate_scomps

integer

Number of non-unique spam complaints.

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’ (See 1 below).

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 campaign. This is the number of messages GreenArrow Studio injected, including messages to addresses in seed lists. Suppressed addresses are not included in this count.

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

integer

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/147/campaign_statistics?started_at__end=1488299101&started_at__start=1364833800

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "sent_text": 0,
    "sent_html": 5,
    "sent_multipart": 0,
    "bounces_total": 0,
    "bounces_unique": 0,
    "bounces_unique_hard": 0,
    "bounces_unique_soft": 0,
    "bounces_unique_other": 0,
    "bounces_unique_local": 0,
    "bounces_unique_remote": 0,
    "clicks_total": 0,
    "clicks_unique": 0,
    "clicks_unique_by_link": 0,
    "opens_total": 0,
    "opens_unique": 0,
    "scomps_total": 0,
    "scomps_unique": 0,
    "scomps_status_updated": 0,
    "unsubs_total": 0,
    "unsubs_unique": 0,
    "unsubs_status_updated": 0,
    "bounces_status_updated": 0,
    "total_messages": 5,
    "total_success": 5,
    "total_failure": 0,
    "total_failure_toolong": 0,
    "skips_error": 0,
    "skips_request": 0,
    "bounces_unique_by_code": {
    },
    "messages_sent": 5,
    "messages_html": 5,
    "messages_text": 0,
    "accepted": 5,
    "accepted_rate": 1.0,
    "in_queue": 0,
    "in_queue_rate": 0.0,
    "max_unique_activities": 0,
    "open_rate": 0.0,
    "open_ratio": 0.0,
    "unopened": 5,
    "duplicate_opens": 0,
    "duplicate_clicks": 0,
    "click_rate": 0.0,
    "click_to_open_rate": 0.0,
    "unclicked": 5,
    "bounced": 0,
    "duplicate_bounces": 0,
    "unbounced": 5,
    "bounce_rate": 0.0,
    "bounce_rate_hard": 0.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": 0,
    "unsub_rate": 0.0
  },
  "error_code": null,
  "error_message": null
}


Copyright © 2012–2019 GreenArrow Email