Skip to content

Commit 22fcb97

Browse files
[SE-231] Adding markdown documentation for events api
1 parent 6523b8d commit 22fcb97

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

docs/resources/events.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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).

0 commit comments

Comments
 (0)