DOCUMENTATION

Reporting endpoints

REST API Reporting Endpoints

List Emails

This endpoint will list all emails

GET /reporting/email/

Example Response:

[
    {
        "id": "XJLz3dV",
        "name": "Centralized Heuristic Throughput",
        "last_send": {
            "id": "qrDwbBJ",
            "customer_id": "fYbC8Te"
        }
    },
    {
        "id": "1mv4Vd0",
        "name": "Cross-Platform Object-Oriented Flexibility",
        "last_send": {
            "id": "pawnfYG",
            "customer_id": "eIHsxT6"
        }
    }
]

Email Report Detail

This endpoint returns weekly totals for email statistics during a specified period of time

GET /reporting/email/EMAIL_ID/data/?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD

The start_date and end_date query parameters are required

Example Response

{
    "dates": [
        "2020-08-17"
    ],
    "data": {
        "bounced": [
            6
        ],
        "complained": [
            2
        ],
        "delivered": [
            80493
        ],
        "invalid_address": [
            20
        ],
        "no_send_bounced": [
            2481
        ],
        "no_send_complained": [
            643
        ],
        "no_send_unsubscribe": [
            13938
        ],
        "sent": [
            80521.0
        ],
        "unsubscribe": [
            47
        ],
        "clicks": [
            635
        ],
        "converted_click_revenue": [
            35466.0
        ],
        "converted_contact_revenue": [
            68.0
        ],
        "converted_open_revenue": [
            1651.0
        ],
        "opens": [
            9040
        ],
        "unique_opens": [
            6977
        ],
        "unique_clicks": [
            411
        ],
        "converted_contact_count": [
            2
        ],
        "converted_click_count": [
            5
        ],
        "converted_open_count": [
            3
        ],
        "total": [
            67650.0
        ],
        "suppressed": [
            0.0
        ],
        "error": [
            0.0
        ],
        "rejected": [
            0.0
        ],
        "no_opt_in": [
            0.0
        ],
        "frequency_cap": [
            0.0
        ],
        "scheduled": [
            0.0
        ],
        "attributed_conversion_count": [
            8
        ],
        "attributed_conversion_revenue": [
            27117.0
        ],
        "delivery_rate": [
            0.9994457750242474
        ],
        "bounce_rate": [
            0.00011882835244489335
        ],
        "complaint_rate": [
            3.960945081496445e-05
        ],
        "reject_rate": [
            0.0
        ],
        "error_rate": [
            0.0
        ],
        "open_rate": [
            0.13817756916800347
        ],
        "click_rate": [
            0.008139742142475195
        ],
        "click_to_open_rate": [
            0.05890784004586499
        ],
        "unsubscribe_rate": [
            0.0009308220941516646
        ]
    },
    "change_data": {},
    "aggregate_data": {}
}

Email Click Report Detail

This endpoint returns a list of weekly click totals (total clicks, total unique sends clicked) for email links during a specified period of time.

GET /reporting/email/EMAIL_ID/data/clicks/?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD

The start_date and end_date query parameters are required

HTTP 200 OK Allow: GET, HEAD, OPTIONS Content-Type: application/json Vary: Accept

[ [ "https://www.pinterest.com/testcorp/", 6, 4 ], [ "https://www.linkedin.com/company/testcorp", 6, 4 ], [ "https://twitter.com/testcorp/", 6, 4 ], [ "https://www.facebook.com/TestCorpUSA/", 7, 5 ] ]

Back to Top