@astralibx/email-analytics 2.0.2 → 2.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -92,18 +92,17 @@ const ruleEngine = createEmailRuleEngine({
|
|
|
92
92
|
});
|
|
93
93
|
```
|
|
94
94
|
|
|
95
|
-
##
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
| [Error Handling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/error-handling.md) | Error classes and codes |
|
|
95
|
+
## Getting Started Guide
|
|
96
|
+
|
|
97
|
+
1. [Configuration](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/configuration.md) — Set up database and timezone
|
|
98
|
+
2. [Event Recording](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/event-recording.md) — Record email events (sent, delivered, bounced, etc.)
|
|
99
|
+
3. [Aggregation](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/aggregation.md) — Aggregate events into queryable stats (**must be scheduled via cron**)
|
|
100
|
+
4. [Querying](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/querying.md) — Query aggregated stats by date range, account, rule, or template
|
|
101
|
+
5. [Integration](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/integration.md) — Wire analytics to email-rule-engine and email-account-manager hooks
|
|
102
|
+
|
|
103
|
+
Reference: [API Routes](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/api-routes.md) | [Programmatic API](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/programmatic-api.md) | [Types](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/types.md) | [Error Handling](https://github.com/Hariprakash1997/astralib/blob/main/packages/email-analytics/docs/error-handling.md)
|
|
104
|
+
|
|
105
|
+
> **Important:** Events must be aggregated before querying. Schedule `aggregateDaily()` via cron (hourly recommended). Without aggregation, query endpoints return empty results.
|
|
107
106
|
|
|
108
107
|
## Exported Types
|
|
109
108
|
|
package/package.json
CHANGED