Skip to main content
GET
/
api
/
v1
/
analytics
/
email
Get email analytics
curl --request GET \
  --url https://backyard.posthoot.com/api/v1/api/v1/analytics/email
{
  "averageReadTime": -9223372036854776000,
  "bounceCount": 123,
  "browserBreakdown": {},
  "cityBreakdown": {},
  "clickCount": 123,
  "clickRate": 123,
  "clickedLinks": [
    {
      "averageTimeToClick": -9223372036854776000,
      "clickCount": 123,
      "clickRate": 123,
      "deviceBreakdown": {},
      "firstClickTime": "<string>",
      "lastClickTime": "<string>",
      "uniqueClicks": 123,
      "url": "<string>"
    }
  ],
  "complaintCount": 123,
  "dayOfWeekBreakdown": {},
  "deviceBreakdown": {},
  "engagementScore": 123,
  "firstOpenTime": -9223372036854776000,
  "geoBreakdown": {},
  "hourlyBreakdown": {},
  "industryAvgClickRate": 123,
  "industryAvgOpenRate": 123,
  "openCount": 123,
  "openRate": 123,
  "osBreakdown": {},
  "regionBreakdown": {},
  "repeatClicks": 123,
  "repeatOpens": 123,
  "timelineData": [
    {
      "browser": "<string>",
      "count": 123,
      "country": "<string>",
      "deviceType": "<string>",
      "eventType": "<string>",
      "timestamp": "<string>",
      "uniqueCount": 123
    }
  ],
  "uniqueClicks": 123,
  "uniqueOpens": 123
}

Query Parameters

emailId
string
required

Email ID

Response

Email analytics

Email analytics data

averageReadTime
enum<integer>

Average time between open and click

Available options:
-9223372036854776000,
9223372036854776000,
1,
1000,
1000000,
1000000000,
60000000000,
3600000000000
bounceCount
integer
browserBreakdown
object
cityBreakdown
object
clickCount
integer
clickRate
number

🔗 Link Analytics

complaintCount
integer
dayOfWeekBreakdown
object

Day name -> count

deviceBreakdown
object

📱 Device & Browser Analytics

engagementScore
number

🎯 Engagement Metrics

firstOpenTime
enum<integer>

Time to first open

Available options:
-9223372036854776000,
9223372036854776000,
1,
1000,
1000000,
1000000000,
60000000000,
3600000000000
geoBreakdown
object

🌍 Geographic Analytics

hourlyBreakdown
object

Hour (0-23) -> count

industryAvgClickRate
number
industryAvgOpenRate
number

📈 Comparative Metrics

openCount
integer

📊 Basic Metrics

openRate
number
osBreakdown
object
regionBreakdown
object
repeatClicks
integer

Number of times same user clicked

repeatOpens
integer

🔄 Retention Metrics

timelineData
object[]

⏰ Time-based Analytics

uniqueClicks
integer
uniqueOpens
integer