NewsMAN API: sms.campaignStats

Sectiuni

Newsman – Knowledge Base

HomeAPISmssms.campaignStats

Metoda API Newsman: sms.campaignStats

Prototip: sms.campaignStats(campaign_id)

Descriere: Returnează statisticile pentru o campanie

Metoda HTTP: GET

Endpoint HTTP: /sms.campaignStats.json

Endpoint XML-RPC: sms.campaignStats

Tip raspuns: struct

Informatii raspuns: Array cu statistici (nr. trimiteri, viteza de trimiteri, deschideri, click-uri, dezabonări, bounce-uri, raportări spam, link-uri rapoarte)

Parametrii request GET

Variabila	Tip	Descriere
campaign_id	string\|int	ID-ul campaniei pentru care se dorește preluarea statisticilor

Parametrii raspuns

Parametru	Descriere
array	Array conținand statistici ale campaniei

Exemplu output

{
    "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"
    }
}

Erori raspuns

Cod	Mesaj	Descriere
407	Missing required param campaign_id	Parametrul campaign_id este obligatoriu
131	No such campaign with ID: %s.	Acces nepermis la campaign_id

Exemple de erori

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

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