NewsMAN API: list.subscribersEvolution

Sectiuni

Newsman – Knowledge Base

HomeAPIListlist.subscribersEvolution

Metoda API Newsman: list.subscribersEvolution

Prototip: list.subscribersEvolution(list_id, start_date, stop_date)

Descriere: Returnează, pentru o listă, evoluția abonaților într-o anumită perioadă (grupată pe zile: nr. total abonați, nr. abonați eligibili, nr. dezabonări, nr. rapoarte spam, nr. hardbounce-uri)

Metoda HTTP: GET

Endpoint HTTP: /list.subscribersEvolution.json

Endpoint XML-RPC: list.subscribersEvolution

Tip raspuns: struct|array

Informatii raspuns: struct Array-uri cheie / valoare, fiecare reprezentând câte o zi din perioadă, fiecare element din array are: list_id, total_subscribers_count, eligible_subscribers_count, date, unsubscribes_count, spam_reports_count, hardbounces_count

Parametrii request GET

Variabila	Tip	Descriere
list_id	string\|int	ID-ul listei pentru care se dorește preluarea evoluției abonaților
start_date	string\|int	Data de început a perioadei pentru care se preiau rezultatele (>=), UTC date, format: YYYY-MM-DD
stop_date	string\|int	Data de sfârșit a perioadei pentru care se preiau rezultatele (<=), UTC date, format: YYYY-MM-DD

Parametrii raspuns

Parametru	Descriere
date	O zi din perioadă
total_subscribers_count	Numărul total al abonaților din listă în ziua respectivă
eligible_subscribers_count	Numărul abonaților eligibili din listă în ziua respectivă
unsubscribes_count	Numărul de dezabonări în ziua respectivă
spam_reports_count	Numărul de rapoarte spam în ziua respectivă
hardbounces_count	Numărul de hardbounce-uri în ziua respectivă

Exemplu output

[
    {
        "list_id": "my_list_id",
        "date": "2022-11-19",
        "total_subscribers_count": 18582,
        "eligible_subscribers_count": 13147,
        "unsubscribes_count": 15,
        "spam_reports_count": 2,
        "hardbounces_count": 0
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-20",
        "total_subscribers_count": 18590,
        "eligible_subscribers_count": 13150,
        "unsubscribes_count": 16,
        "spam_reports_count": 2,
        "hardbounces_count": 0
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-21",
        "total_subscribers_count": 18594,
        "eligible_subscribers_count": 13147,
        "unsubscribes_count": 18,
        "spam_reports_count": 2,
        "hardbounces_count": 0
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-22",
        "total_subscribers_count": 18600,
        "eligible_subscribers_count": 13144,
        "unsubscribes_count": 31,
        "spam_reports_count": 1,
        "hardbounces_count": 1
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-23",
        "total_subscribers_count": 18606,
        "eligible_subscribers_count": 13143,
        "unsubscribes_count": 20,
        "spam_reports_count": 3,
        "hardbounces_count": 0
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-24",
        "total_subscribers_count": 18610,
        "eligible_subscribers_count": 13142,
        "unsubscribes_count": 14,
        "spam_reports_count": 1,
        "hardbounces_count": 3
    },
    {
        "list_id": "my_list_id",
        "date": "2022-11-25",
        "total_subscribers_count": 18610,
        "eligible_subscribers_count": 13138,
        "unsubscribes_count": 76,
        "spam_reports_count": 1,
        "hardbounces_count": 141
    }
]

Erori raspuns

Cod	Mesaj	Descriere
14003	There was an error retrieving the data	Data could not be retrieved due to an error
407	Missing required param list_id	Parametrul list_id este obligatoriu
407	Missing required param start_date	Parametrul start_date este obligatoriu
407	Missing required param stop_date	Parametrul stop_date este obligatoriu
14001	The period interval must be max 90 days	Intervalul perioadei trebuie să fie de maxim 90 zile
14002	The period interval is invalid	Intervalul definit de start_date și stop_date este invalid (minim 2 zile, maxim 90 zile, start_date < stop_date)
14003	There was an error retrieving the data	Datele nu au putut fi preluare din cauza unui erori

Exemple de erori

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

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

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

{
    "err": true,
    "message": "The period interval must be max 90 days",
    "code": 14001
}

{
    "err": true,
    "message": "The period interval is invalid",
    "code": 14002
}

{
    "err": true,
    "message": "There was an error retrieving the data",
    "code": 14003
}