File tree Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Expand file tree Collapse file tree 1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Events
2
+
3
+ This library provides easy access to the [ Events] ( https://developers.sparkpost.com/api/events ) resource.
4
+
5
+ * Note: All methods return promises and accept an optional last argument callback. [ Read about how we handle callbacks and promises] ( /docs/async.md ) .*
6
+
7
+ ## Methods
8
+ * ** searchMessage([ params, callback] )** <br />
9
+ Search for events of type message using the given parameters (NOTE: all params are optional):
10
+ * ` params ` - a hash of [ Events URI Parameters] ( https://developers.sparkpost.com/api/events.html#events-get-search-for-message-events )
11
+
12
+ ## Date/Time Parameter Format
13
+
14
+ The ` from ` and ` to ` search parameters accept date stamps of the form:
15
+
16
+ ` YYYY-MM-DDTHH:MM `
17
+
18
+ For example: ` 2016-11-14T16:15 ` .
19
+
20
+ Note: timestamps are expressed in the timezone specified by the ` timezone ` parameter or UTC by default.
21
+
22
+ ## Examples
23
+
24
+ Visit our examples section to see all of [ our events resource examples] ( /examples/events ) .
You can’t perform that action at this time.
0 commit comments