Connector

get_outreach_summary

Set this up in your agent

get_outreach_summary(brand_id)

Shows how outreach is going for a brand: counts, the next send day, and the progress phase. No contacts.

Parameters

brand_idstringRequired
Brand the user confirmed.

Returns

live_messages_totalnumber
Live outreach messages.
ready_countnumber
Messages ready to send.
scheduled_for_next_sendnumber
Messages scheduled for the next send.
sent_countnumber
Messages already sent.
next_send_atstring
Next send day.
batch_weekdaystring
Weekday of the send batch.
target_countnumber
Target number of messages.
progress_phasestring
preparing, sending, or complete_rolled.
capacitynumber
Send capacity.
gapnumber
Gap between the target and what is ready.