NewsMAN API: automation.all

Sectiuni

Newsman – Knowledge Base

HomeAPIAutomationautomation.all

Metoda API Newsman: automation.all

Prototip: automation.all(list_id, name, type, status, start_date, stop_date)

Descriere: Returnează o listă cu automatizări având nume $name, tip $type, status $status actualizate între $start_date, $stop_date (inclusiv)

Metoda HTTP: GET

Endpoint HTTP: /automation.all.json

Endpoint XML-RPC: automation.all

Tip raspuns: struct

Informatii raspuns: Array cu automatizări. Fiecare element este un array cheie / valoare având cheile: workflow_id, list_id, name, type, key, key_recurrent, recurrence, modified_at, status, version, stats, preview_link, preview_images, allow_reprocess, allow_import_process, workflow_frequency, workflow_frequency_days

Parametrii request GET

Variabila	Tip	Descriere
list_id	string\|int	ID-ul listei pentru care se dorește preluarea automatizărilor
name	string	Numele automatizării
type	string	Tipul poate fi: all - toate automatizările sub_date newsletter_view newsletter_click advanced unsub manual ecommerce_cart_update ecommerce_order_completed ecommerce_product_view
status	boolean\|int\|string	Status-ul poate fi: all - toate automatizările 0 - inactiv 1 - activ
start_date	datetime\|string\|boolean	Începutul perioadei în care a fost actualizată automatizarea
stop_date	datetime\|string\|boolean	Sfârșitul perioadei în care a fost actualizată automatizarea

Parametrii raspuns

Parametru	Descriere
workflow_id	Id-ul automatizării
list_id	Id-ul listei automatizării
name	Numele automatizării
type	Tipul automatizării
key	Parametrul key al automatizării (dacă există, pentru automatizări de tip advanced)
key_recurrent	Parametrul key_recurrent al automatizării (dacă există, pentru automatizări de tip advanced)
recurrence	Recurentă automatizării (once, sau yearly pentru automatizări de tip dată)
modified_at	Timestamp ultimei modificări a automatizării
status	Status-ul automatizării
version	Versiunea automatizării (2 pentru scheme logice, 1 pentru tabele legacy)
stats	Un array conținând statistici cumulate pentru newsletterele trimise prin workflow (ex: sent, open_rate, click_rate)
preview_images	Array conținând URL-uri de imagini de preview (pentru scheme logice)
allow_reprocess	Daca este permisă procesarea recurentă (eg: pentru fiecare acțiune a aceluiași user)
allow_import_process	Dacă automatizarea ar trebui să asculte după importuri
workflow_frequency	Dacă automatizarea ar trebui să se execute de fiecare dată pentru același user (default) sau are frecvența limitată (limit)
workflow_frequency_days	Numărul de zile la care este limitată frecvența (dacă este activă limita)

Exemplu output

[
    {
        "workflow_id": "the_workflow_id",
        "list_id": "the_list_id",
        "name": "the_name",
        "type": "advanced",
        "key": "test_prop",
        "key_recurrent": "",
        "recurrence": "once",
        "modified_at": 1637592573,
        "status": 0,
        "version": 2,
        "allow_reprocess": 0,
        "allow_import_process": 0,
        "workflow_frequency": "default",
        "workflow_frequency_days": 0,
        "preview_link": "the_link",
        "preview_images": {
            "full": "the_full_src.png",
            "mini": "the_mini_src.png"
        },
        "stats": {
            "newsletter_id": "the_id",
            "type": "master",
            "trigger_id": "General",
            "subject": "General workflow report",
            "sent": 3,
            "unique_views": 3,
            "open_rate": 100,
            "unique_clicks": 1,
            "click_rate": 33.33,
            "unsubscribe_count": 0,
            "bounce_count": 0
        }
    }
]

Erori raspuns

Cod	Mesaj	Descriere
407	Missing required param list_id	Parametrul list_id este obligatoriu
407	Missing required param name	Parametrul name este obligatoriu
407	Missing required param type	Parametrul type este obligatoriu
407	Missing required param start_date	Parametrul start_date este obligatoriu
407	Missing required param stop_date	Parametrul stop_date este obligatoriu
407	Missing required param status	Parametrul status este obligatoriu
101	Not allowed for list_id = %s	Acces nepermis la list_id

Exemple de erori

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

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

{
    "err": true,
    "message": "Missing required param type",
    "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": "Missing required param status",
    "code": 407
}

{
    "err": true,
    "message": "Invalid workflow type",
    "code": 13001
}