This endpoint fetches exchange data, which represents a conversation between a bot and a contact. It can be filtered by campaign, a date range, and the type of exchange (e.g., positive replies vs. meetings booked).
int, optional): The ID of a specific campaign to filter by. If omitted, exchanges from all campaigns are returned.str, optional): The start of the date range for filtering exchanges, in YYYY-MM-DD format. Defaults to 2023-01-01.str, optional): The end of the date range for filtering exchanges, in YYYY-MM-DD format. Defaults to the current date.str, optional): The category of exchanges to retrieve. Defaults to "replied". Possible values: "replied", "meeting-booked".Returns a JSON array of BaseExchange objects.
Key used to authenticate user API requests.
replied, meeting-booked Successful Response
{
"email": "[email protected]",
"first_name": "Guido",
"id": 1,
"last_name": "van Rossum",
"organisation": "Microsoft"
}{
"email": "[email protected]",
"first_name": "Guido",
"id": 1,
"last_name": "van Rossum",
"organisation": "Microsoft"
}OUTREACH_PENDING, OUTREACH_QUEUED, OUTREACH_ACTIVE, NO_RESPONSE, INVALID_ADDRESS, FAILED_DELIVERY, UNSUB_LINK, UNSUB_REQUEST, DECLINED, FOLLOWUP_LATER, FOLLOWUP_SENT, PROVIDED_REFERRAL, OUTREACH_REFERRAL, SCHEDULING_MEETING, INFO_INQUIRY, AWAITING_REPLY, NURTURING, MEETING_BOOKED, OTHER_CONVERSION