/
Automation Workflow Analytics API Methods

Automation Workflow Analytics API Methods

Table of Contents:

GET /analytics/api/v0/report/workflows

Description 

This method retrieves analytics for all automations in the list within the specified date range. The data shown represents the automation as a whole and does not include metrics for individual automation branches.

Request

list_id: The list ID in the Ongage account.

date_from: The start date for retrieving data. (Date should be URL encoded)

date_to: The end date for retrieving data. (Date should be URL encoded)

Format: MM/DD/YY

Example Request URL

https://api.ongage.com/analytics/api/v0/report/workflows?list_id=<list_id>&date_from=01%2F01%2F26&date_to=01%2F29%2F26

Response

{ "metadata": { "error": false, "total": 2 }, "payload": [ { "workflow_id": "d883a197-4071-493e-a90a-a378807eeab9", "workflow_name": "New Workflow (222)", "workflow_status": "live", "list_id": 9381, "sents": "0", "success": "0", "success_percent": "0%", "failed": "0", "failed_percent": "0%", "hard_bounces": "0", "hard_bounces_percent": "0%", "soft_bounces": "0", "soft_bounces_percent": "0%", "opens": "1", "opens_percent": "0%", "unique_opens": "1", "unique_opens_percent": "0%", "clicks": "0", "ctr": "0%", "unique_clicks": "0", "uctr": "0%", "unsubscribes": "0", "unsubscribes_percent": "0%", "complaints": "0", "complaints_percent": "0%" }, { "workflow_id": "d79dfe76-0b5e-4ea5-ace5-bde18fe5b68d", "workflow_name": "New Workflow (266)", "workflow_status": "freeze", "list_id": 9381, "sents": "0", "success": "0", "success_percent": "0%", "failed": "0", "failed_percent": "0%", "hard_bounces": "0", "hard_bounces_percent": "0%", "soft_bounces": "0", "soft_bounces_percent": "0%", "opens": "10", "opens_percent": "0%", "unique_opens": "10", "unique_opens_percent": "0%", "clicks": "0", "ctr": "0%", "unique_clicks": "0", "uctr": "0%", "unsubscribes": "2", "unsubscribes_percent": "0%", "complaints": "0", "complaints_percent": "0%" } ] }

Note

  • workflow_id: The unique ID of the automation workflow.

  • workflow_name: The name of the automation workflow.

  • workflow_status: The current status of the automation workflow.

GET /analytics/api/v0/report/workflow/messages

Description 

This method retrieves analytics for each sub-branch individually across all automations in the list within the specified date range.

Request

list_id: The list ID in the Ongage account.

date_from: The start date for retrieving data. (Date should be URL encoded)

date_to: The end date for retrieving data. (Date should be URL encoded)

Format: MM/DD/YY

Example Request URL

https://api.ongage.com/analytics/api/v0/report/workflow/messages?list_id=<list_id>&date_from=01%2F01%2F26&date_to=01%2F29%2F26

Response

{ "metadata": { "error": false, "total": 3 }, "payload": [ { "workflow_id": "d883a197-4071-493e-a90a-a378807eeab9", "workflow_name": "New Workflow (222)", "list_id": 9381, "node_id": "15afb384-94c0-4f17-a88e-4e4c8cca8a33", "node_name": "Send email to client", "node_subtype": "send_email", "node_ab": null, "message_id": 16387745, "message_name": "Ongage Support Test", "message_subject": "Ongage Support Test", "sents": "0", "success": "0", "success_percent": "0%", "failed": "0", "failed_percent": "0%", "hard_bounces": "0", "hard_bounces_percent": "0%", "soft_bounces": "0", "soft_bounces_percent": "0%", "opens": "1", "opens_percent": "0%", "unique_opens": "1", "unique_opens_percent": "0%", "clicks": "0", "ctr": "0%", "unique_clicks": "0", "uctr": "0%", "unsubscribes": "0", "unsubscribes_percent": "0%", "complaints": "0", "complaints_percent": "0%" }, { "workflow_id": "d79dfe76-0b5e-4ea5-ace5-bde18fe5b68d", "workflow_name": "New Workflow (266)", "list_id": 9381, "node_id": "f1085ee4-374c-45c3-99ba-e99d667dc923", "node_name": "Send email to client", "node_subtype": "send_email", "node_ab": null, "message_id": 16927191, "message_name": "Ongage complete test (copy)", "message_subject": "Ongage Complete Test", "sents": "0", "success": "0", "success_percent": "0%", "failed": "0", "failed_percent": "0%", "hard_bounces": "0", "hard_bounces_percent": "0%", "soft_bounces": "0", "soft_bounces_percent": "0%", "opens": "4", "opens_percent": "0%", "unique_opens": "4", "unique_opens_percent": "0%", "clicks": "0", "ctr": "0%", "unique_clicks": "0", "uctr": "0%", "unsubscribes": "1", "unsubscribes_percent": "0%", "complaints": "0", "complaints_percent": "0%" }, { "workflow_id": "d79dfe76-0b5e-4ea5-ace5-bde18fe5b68d", "workflow_name": "New Workflow (266)", "list_id": 9381, "node_id": "9f7771b1-8f64-4301-ae50-289f783cfeae", "node_name": "Send email to client", "node_subtype": "send_email", "node_ab": "message", "message_id": 16914132, "message_name": "liav - test", "message_subject": "asdfasdf", "sents": "0", "success": "0", "success_percent": "0%", "failed": "0", "failed_percent": "0%", "hard_bounces": "0", "hard_bounces_percent": "0%", "soft_bounces": "0", "soft_bounces_percent": "0%", "opens": "2", "opens_percent": "0%", "unique_opens": "2", "unique_opens_percent": "0%", "clicks": "0", "ctr": "0%", "unique_clicks": "0", "uctr": "0%", "unsubscribes": "0", "unsubscribes_percent": "0%", "complaints": "0", "complaints_percent": "0%" } ] }

Notes

  • node_id: A unique ID for each branch within the automation workflow.

  • node_name: The name of the corresponding branch within the automation workflow.

  • node_subtype: The type of branch (for example, send email, webhook, update contact, etc.).

  • node_ab: Indicates whether an A/B split test is enabled for the branch.

  • message_id: The unique ID of the email message used in the automation workflow branch.

  • message_name: The name of the email message used in the automation workflow branch.

  • message_subject: The email message subject line used in the automation workflow branch.