Variable | Type | Description |
---|---|---|
list_id | string|int | The ID of the list for which to get the workflows |
name | string | The name of the workflow |
type | string | Type of workflow can be:
|
status | boolean|int|string | Status of workflow can be:
|
start_date | datetime|string|boolean | Start of the period between which the workflow was updated |
stop_date | datetime|string|boolean | End of the period between which the workflow was updated |
Parameter | Description |
---|---|
workflow_id | The id of the workflow |
list_id | The list_id of the workflow |
name | The name of the workflow |
type | The type of the workflow |
key | The key of the workflow (if exists, for advanced type workflows) |
key_recurrent | The key_recurrent of the workflow (if exists, for advanced type workflows) |
recurrence | The recurrence of the workflow (once, or yearly for date type workflows) |
modified_at | The timestamp of the last update of the workflow |
status | The status of the workflow |
version | The version of the workflow (2 for visual schema workflows, 1 for legacy table workflows) |
stats | An array containing the aggregate stats for the newsletters sent through the workflow (eg: sent, open_rate, click_rate) |
preview_link | The public preview URL (for visual schema workflows) |
preview_images | Array with URls for preview images (for visual schema workflows) |
allow_reprocess | If recurrent processing is allowed (eg: for every subscribe action of the same user) |
allow_import_process | If the workflow should listen for imports |
workflow_frequency | If the workflow should execute every time for the same user (default) or the frequency is limited (limit) |
workflow_frequency_days | The number of days to which the frequency is limited (if the limit is active) |
preview_link | URL-ul de preview public (pentru scheme logice) |
[ { "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 } } ]
Code | Message | Description |
---|---|---|
407 | Missing required param list_id | list_id param is required |
407 | Missing required param name | name param is required |
407 | Missing required param type | type param is required |
407 | Missing required param start_date | start_date param is required |
407 | Missing required param stop_date | stop_date param is required |
407 | Missing required param status | status param is required |
101 | Not allowed for list_id = %s | Invalid access to list_id |
13001 | Invalid workflow type | Invalid workflow type |
13001 | Invalid workflow type | Tip-ul workflow-ului este invalid |
{ "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 }