OutreachAgent
Sign InDeploy Agent

Documentation

DocsAdvanced FeaturesWorkflow Analytics

Workflow Analytics

Get aggregate enrollment and email statistics for any workflow.

WorkflowAnalytics
{
  workflowId: string,
  totalEnrollments: number,
  activeEnrollments: number,
  completedEnrollments: number,
  exitedEnrollments: number,
  failedEnrollments: number,
  emailsSent: number,
  emailsBounced: number,
  completionRate: number,
  exitRate: number,

  // Cold email deliverability metrics
  deliverability?: {
    replyRate: number,           // replies / emails sent
    positiveReplyRate: number,   // interested replies / emails sent
    bounceRate: number,          // bounces / emails sent
    optOutRate: number,          // unsubscribes / emails sent
    avgTimeToReplyMinutes: number | null
  },

  // Per-step breakdown
  steps?: [{
    nodeId: string,
    nodeLabel: string,
    sent: number,
    delivered: number,
    bounced: number,
    replied: number,
    positiveReplies: number
  }]
}
TypeScript
const analytics = await client.getWorkflowAnalytics("wf_abc");
console.log(analytics.completionRate);  // 0.72
console.log(analytics.emailsSent);      // 1540
curl
curl https://api.outreachagent.dev/v1/workflows/wf_abc/analytics \
  -H "Authorization: Bearer $OUTREACHAGENT_API_KEY"