Skip to main content
GET
Get incoming email trends for top client domains
Returns the daily incoming email trends for the top 5 client domains within the specified date range. Only incoming emails are counted. The response provides a series array suitable for time-series visualization.

Request

Headers

Path Parameters

Parameter Format

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

Response

401 Unauthorized

500 Internal Server Error

Example

Data Structure

Labels Array

Series Array

Each object represents a domain’s daily email counts:

Data Alignment

  • series[i].data[j] corresponds to labels[j] for the domain series[i].name
  • All data arrays have the same length as labels
  • Only incoming emails are counted (outgoing emails excluded)

Use Cases

  • Client Behavior Analysis: Track email patterns by domain
  • Capacity Planning: Predict volume from top domains
  • Service Level Management: Monitor domain-specific service levels
  • Trend Identification: Spot increasing/decreasing domain activity
  • Visualization: Create multi-line charts for domain trends

Analysis Examples

Domain Growth Analysis

Peak Day Identification

Correlation Analysis

Visualization Examples

Multi-Line Chart

Stacked Area Chart

Best Practices

  1. Date Range: Use reasonable ranges (recommended: max 90 days)
  2. Focus: Top 5 domains provide focused view without overwhelming data
  3. Comparison: Compare trends across domains for insights
  4. Baseline: Establish baseline patterns for anomaly detection
  5. Regular Updates: Update trends regularly for current insights

Performance Considerations

  • Data Volume: Multiple series increase data complexity
  • Caching: Results cached for 15 minutes by default
  • Processing: Larger date ranges take longer to process
  • Memory: Consider client-side memory for large datasets
  • Use /email-meter/stats/clients/top-domains for current top domains
  • Use /email-meter/stats/emails-trend for overall email trends
  • Use /email-meter/stats/clients/response-times for domain performance

Notes

  • Only incoming emails are included in counts
  • Top 5 domains are based on total volume in the date range
  • Zero-volume days are included for complete timeline
  • Data is calculated based on email receipt timestamps
  • Internal domains may be excluded based on configuration

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 for the trend range (YYYY-MM-DD)

endDate
string<date>
required

End date for the trend range (YYYY-MM-DD)

Response

Successfully retrieved incoming email trends for top client domains

message
string
Example:

""

data
object