Get email stats
https://api.ruuster.com/v1/emails/statsRuuster email sent to your leads (saved-search alerts and listing updates): sends, deliveries, human opens and clicks, optionally per saved search. These rates are stricter than the open and click rates in Ruuster's weekly analytics email, which count automatic and repeat opens; for a headline rate that matches that email, use summary's weeklyEmail figures, and present these as the detail, not as a discrepancy.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: 120 requests per minute per key
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
from |
date | 30 days before to |
First day, YYYY-MM-DD in America/Chicago, included |
to |
date | today | Day after the last day, YYYY-MM-DD, excluded |
granularity |
string | week |
day, week (Monday start) or month |
groupBy |
string | savedSearch adds bySavedSearch[] to each bucket: savedSearchId, name, sent, openedHuman, clicked |
|
cursor |
string | With groupBy, meta.nextCursor from the previous page of saved searches |
|
limit |
integer | 100 |
With groupBy, saved searches per page, 1 to 500 |
Response
Each bucket: sent, delivered, uniqueRecipients, opened (all recorded opens, including automated ones), openedHuman (opens that don't look automated; best-effort), openRateHuman, clicked, clickRate. Rates are over delivered.
Emails are counted on the Central day they were sent; opens and clicks are added to that day as they arrive, so the last 14 days can still increase. uniqueRecipients is distinct per day and summed across the bucket's days.