NewsMAN API: newsletter.stats

Sections

Newsman – Knowledge Base

HomeAPINewsletternewsletter.stats

Newsman Api Method: newsletter.stats

Prototype: newsletter.stats(newsletter_id)

Description: Returns stats for the specified newsletter

HTTP method: GET

Endpoint HTTP: /newsletter.stats.json

Endpoint XML-RPC: newsletter.stats

Return type: struct

Return info: Array with stats (send count, send speed, views, clicks, unsubscribes, bounces, spam reports, report links)

Request parameters GET

Variable	Type	Description
newsletter_id	string\|int	The ID of the newsletter for which to get the stats

Response parameters

Parameter	Description
array	Array containing stats of the newsletter

Output example

{
    "id": 40001,
    "subject": "A subject here",
    "send_count": "3",
    "segments": [
        {
            "id": "50005",
            "name": "test_segment"
        }
    ],
    "list": {
        "id": "my_list_id",
        "name": "My list"
    },
    "total_views": "3",
    "unique_views": "3",
    "views_percent": 100,
    "total_clicks": "0",
    "unique_clicks": "0",
    "clicks_percent": 0,
    "rate_of_interest": 0,
    "total_likes": "0",
    "unique_likes": "0",
    "total_tweets": "0",
    "unique_tweets": "0",
    "total_linkedin": "0",
    "unique_linkedin": "0",
    "total_plusone": "0",
    "unique_plusone": "0",
    "total_pinterest": "0",
    "unique_pinterest": "0",
    "unsubscribe_count": "0",
    "unsubscribe_percent": 0,
    "bounce_count": "0",
    "bounce_percent": 0,
    "spam_count": "0",
    "spam_percent": 0,
    "send_rate_per_minute": "3",
    "send_duration_seconds": 52,
    "view_online": "view_online_link",
    "visual_report": "visual_report_link",
    "create_date": "2017-05-31 12:16:44",
    "status": "trimis",
    "status_id": "5",
    "is_abtest": 0,
    "preview": {
        "thumb": "thumb_src",
        "full": "full_src"
    }
}

Response Errors

Code	Message	Description
407	Missing required param newsletter_id	newsletter_id param is required
131	No such newsletter with ID: %s.	Invalid access to newsletter_id

Error examples

{
    "err": true,
    "message": "Missing required param newsletter_id",
    "code": 407
}

{
    "err": true,
    "message": "No such newsletter with ID: 99554.",
    "code": 131
}