Analytics

Fetch campaign analytics

Return json data statistics about campaigns sent

URL

/analytics/campaign_mailing_send_totals

Method

GET

URL Parameters

Optional:

campaign_mailing_send_id=[string] Id of a specific campaign to total.

Success response

Code: 200
Content:

{
"data": {
"delivered": "number",
"viewed": "number",
"clicked": "number",
"bounced": "number",
"soft_bounced": "number",
"hard_bounced": "number",
"unsubscribed": "number",
"global_unsubscribed": "number"
}
}

Fetch campaign table

Return json data information about campaigns sent

URL

/analytics/campaign_mailing_sends_table

Method

GET

URL Parameters

Optional:

search=[{ field: value }] Field:Value pair to search on. Defaults to all records.

order_by=[attribute] Order by attributes. Defaults to created_at.

order[asc|desc] Defaults to descending.

Success Response

Code: 200
Content:

{
"data": [
{
"id": "string",
"marketing_email_id": "string",
"campaign_mailing_id": "string",
"campaign_mailing_created_at": "DateTime string",
"sent_at": "DateTime string",
"subscription_list_name": "string"
}
]
}

Fetch tracking links by unique link

Returns json data about interactions with tracking links.

URL

/analytics/tracking_links_by_unique_link

Method

GET

URL Parameteres

campaign_mailing_send_id=[string] Campaign id to search on.

Optional:

order_by=[attribute] Order by attributes. Defaults to created_at.

order=[asc|desc] Defaults to descending.

Success Response

Code: 200
Content:

{
"data": [
{
"html_id": "number",
"target_url": "string",
"clicked": "number"
}
]
}

Fetch subscribers by tracking link

Returns json data about subscribers for a specific tracking link.

URL

/analytics/subscribers_by_tracking_link

Method

GET

URL Parameters

campaign_mailing_send_id=[string] Campaign id to search on.

html_id=[number] html_id of the associated tracking link.

Optional:

order_by=[attribute] Order by non-id attributes. Defaults to created_at.

order=[asc|desc] Defaults to descending.

Success Response

Code: 200
Content:

{
"data": [
{
"id": "string",
"type": "string",
"attributes" : {
"email": "string",
"first_name": "string",
"last_name": "string",
"custom_fields": [
{
"subscriber_custom_field_type_id": "string",
"value": "string"
}
]
}
}
]
}

Fetch campaign deliveries table

Returns json data about campaign deliveries sent.

URL

/analytics/campaign_mailing_deliveries_table

Method

GET

URL Parameters

One of the following id's is required.

campaign_mailing_send_id=[string] Campaign id to search on.

campaign_mailing_id=[string] Paubox Marketing Campaign Email id to search on.

Success Response

Code: 200
Content:

{
"data": [
{
"recipient": "string",
"created_at": "DateTime string",
"delivered": "boolean",
"viewed": "boolean",
"clicked": "boolean",
"bounced": "boolean",
"unsubscribed": "boolean",
"https:www.example.com": "string"
}
]
}