analytics
Get a comprehensive report of engagement statistics across all selected sequences for a specified time period.
post/v1/analytics/consolidated-stats
Request
- Base URLhttps://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"sequenceIds": [
"2dP27N0gZ4",
"2dP27NugZ3",
"2dP27NrgZ3"
],
"startDate": "2024-11-15",
"endDate": "2024-11-19",
"pageNum": 1,
"pageLimit": 25
}Response
Sequence prospects & emails stats fetched successfully
unknown required
Example response
{
"message": "Sequence prospects & emails stats fetched successfully",
"payload": {
"data": [
{
"Sequence Title": "Welcome Campaign",
"Sequence Owner": "John Doe",
"Step Id": "Xq7MkR2PdN",
"Step Number": 1,
"Sender Email": "sender1@example.com",
"Recipient Email": "recipient1@example.com",
"Recipient name": "Jane Smith",
"Email Sent At": "Thu Dec 18 2024 10:59:29 GMT+5:30 (Asia/Kolkata)",
"Open Count": 2,
"Last Opened At": "Thu Nov 18 2024 12:04:40 GMT+5:30 (Asia/Kolkata)",
"Replied": "Yes",
"Replied At": "",
"Conversation Id": "",
"Current Sentiment": "Positive",
"Click Count": 3,
"Last Clicked At": "Thu Nov 22 2024 08:24:40 GMT+5:30 (Asia/Kolkata)",
"Last Link Clicked": "https://example.com/offer",
"Bounced": "No",
"Bounced At": "",
"Unsubscribed": "No",
"Deleted": "No",
"Sequence Id": "8Jwomvq5aO",
"Variant": "A",
"Variant Id": "pLm5NkQ8aZ",
"Client": {
"id": "g9bzZq4aMd",
"firstName": "john",
"lastName": "doe",
"email": "johndoe+5@saleshandy.com",
"status": "active",
"companyName": "Demo"
}
},
{
"Sequence Title": "Follow-Up Sequence",
"Sequence Owner": "Alice Johnson",
"Step Id": "Yr8NlS3QeO",
"Step Number": 2,
"Sender Email": "alice.j@example.com",
"Recipient Email": "recipient2@example.com",
"Recipient name": "Michael Brown",
"Email Sent At": "Fri Dec 20 2024 09:45:00 GMT+5:30 (Asia/Kolkata)",
"Open Count": 5,
"Last Opened At": "Fri Dec 22 2024 10:15:00 GMT+5:30 (Asia/Kolkata)",
"Replied": "No",
"Replied At": "",
"Conversation Id": "",
"Current Sentiment": "Neutral",
"Click Count": 1,
"Last Clicked At": "Fri Dec 22 2024 11:30:00 GMT+5:30 (Asia/Kolkata)",
"Last Link Clicked": "https://example.com/product",
"Bounced": "No",
"Bounced At": "",
"Unsubscribed": "No",
"Deleted": "No",
"Sequence Id": "9XpRq4aYZ",
"Variant": "B",
"Variant Id": "qMn6OlR9bA",
"Client": {
"id": "h4mQkZ2nAf",
"firstName": "alice",
"lastName": "johnson",
"email": "alicejohnson+2@saleshandy.com",
"status": "active",
"companyName": "TechCorp"
}
},
{
"Sequence Title": "Closing Campaign",
"Sequence Owner": "Mark White",
"Step Id": "Zs9OmT4RfP",
"Step Number": 3,
"Sender Email": "mark.w@example.com",
"Recipient Email": "recipient3@example.com",
"Recipient name": "Sarah Lee",
"Email Sent At": "Sat Dec 21 2024 14:30:00 GMT+5:30 (Asia/Kolkata)",
"Open Count": 8,
"Last Opened At": "Sat Dec 23 2024 16:45:00 GMT+5:30 (Asia/Kolkata)",
"Replied": "Yes",
"Replied At": "Sat Dec 23 2024 17:00:00 GMT+5:30 (Asia/Kolkata)",
"Conversation Id": "8aJq9W4oBv",
"Current Sentiment": "Positive",
"Click Count": 4,
"Last Clicked At": "Sat Dec 23 2024 18:30:00 GMT+5:30 (Asia/Kolkata)",
"Last Link Clicked": "https://example.com/discount",
"Bounced": "No",
"Bounced At": "",
"Unsubscribed": "Yes",
"Deleted": "No",
"Sequence Id": "5QwoKv8aBn",
"Variant": "A",
"Variant Id": "rNo7PmS0cB",
"Client": {}
}
],
"hasMore": false,
"nextPageNumber": 1
}
}Changes
No recorded changes to this operation across all 4 revisions of this API.