Skip to main content
GET
Get daily email activity trend
Retrieves the trend of incoming and sent emails across the specified date range. Each label in labels corresponds to a date in the range, and series contains counts of sent and received emails for each day.

Request

Headers

Path Parameters

Parameter Format

  • Format: YYYY-MM-DD (ISO 8601 date)
  • Timezone: UTC
  • Default: Last 7 days if not provided

Response

200 OK - Successfully retrieved email activity trend

401 Unauthorized

500 Internal Server Error

Example

Data Structure

Series Array

Each object in the series represents:

Labels Array

Data Alignment

  • series[0].data[i] corresponds to labels[i] for Incoming emails
  • series[1].data[i] corresponds to labels[i] for Sent emails
  • All arrays have the same length

Use Cases

  • Trend Analysis: Visualize email volume over time
  • Capacity Planning: Identify peak email periods
  • Performance Monitoring: Track daily email patterns
  • Dashboard Visualization: Create line charts and graphs
  • Seasonal Patterns: Identify weekly/monthly trends

Visualization Examples

Line Chart

Bar Chart

Analysis Metrics

Daily Totals

Trend Calculations

Best Practices

  1. Date Range: Use reasonable ranges (recommended: max 90 days)
  2. Caching: Cache trend data for dashboard performance
  3. Real-time Updates: Update trends periodically for live dashboards
  4. Empty Data: Handle days with zero emails gracefully
  5. Time Zones: Consider converting to local time zones for display

Performance Considerations

  • Large Ranges: Longer date ranges may take more time to process
  • Data Points: Each day represents a data point
  • Caching: Results are cached for 15 minutes by default
  • Memory Usage: Large datasets may impact client-side rendering
  • Use /email-meter/stats/hourly-trends for hourly breakdown
  • Use /email-meter/stats/email-counts for aggregate statistics
  • Use /email-meter/stats/clients/incoming-trends for client-specific trends

Notes

  • Data includes all email types (incoming, outgoing, internal)
  • Weekends and holidays are included in the trend
  • Zero-value days are included for complete timeline
  • Data is calculated based on email timestamps in UTC
  • Automated emails are included in counts unless filtered

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

startDate
string<date>
required

Start date of the range (ISO 8601). Defaults to 7 days before today if not provided.

endDate
string<date>
required

End date of the range (ISO 8601). Defaults to today if not provided.

Response

Successfully retrieved email activity trend

message
string
data
object