Skip to content

Commit f86312b

Browse files
committed
update docs
1 parent abe09bd commit f86312b

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

docs/api/tags.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,46 @@ Method | Path
2424
--- | ---
2525
GET | /{domain}/tags/{tag}
2626

27+
### `info`
28+
29+
Returns statistics for a given tag.
30+
31+
`mailgun.tags({tag}).stats().info({callback});`
32+
33+
Method | Path
34+
--- | ---
35+
GET | /{domain}/tags/{tag}/stats
36+
37+
### `list`
38+
39+
Returns a list of countries of origin for a given domain for different event types.
40+
41+
`mailgun.tags({tag}).stats().aggregates().countries().list({callback});`
42+
43+
Method | Path
44+
--- | ---
45+
GET | /{domain}/tags/{tag}/stats/aggregates/countries
46+
47+
### `list`
48+
49+
Returns a list of email providers for a given domain for different event types.
50+
51+
`mailgun.tags({tag}).stats().aggregates().providers().list({callback});`
52+
53+
Method | Path
54+
--- | ---
55+
GET | /{domain}/tags/{tag}/stats/aggregates/providers
56+
57+
### `list`
58+
59+
Returns a list of devices for a given domain that have triggered event types.
60+
61+
`mailgun.tags({tag}).stats().aggregates().devices().list({callback});`
62+
63+
Method | Path
64+
--- | ---
65+
GET | /{domain}/tags/{tag}/stats/aggregates/devices
66+
2767
### `delete`
2868

2969
Deletes all counters for particular tag and the tag itself.

docs/api/tracking.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# tracking
2+
3+
Programmatically get and modify domain tracking settings.
4+
5+
## Actions
6+
7+
### `info`
8+
9+
Returns tracking settings for a domain.
10+
11+
`mailgun.domains({domain}).tracking().info({callback});`
12+
13+
Method | Path
14+
--- | ---
15+
GET | /domains/{domain}/tracking
16+
17+
### `update`
18+
19+
Updates the open tracking settings for a domain.
20+
21+
`mailgun.domains({domain}).tracking().open().update({attributes}, {callback});`
22+
23+
Method | Path
24+
--- | ---
25+
PUT | /domains/{domain}/tracking/open
26+
27+
### `update`
28+
29+
Updates the click tracking settings for a domain.
30+
31+
`mailgun.domains({domain}).tracking().click().update({attributes}, {callback});`
32+
33+
Method | Path
34+
--- | ---
35+
PUT | /domains/{domain}/tracking/click
36+
37+
### `update`
38+
39+
Updates the unsubscribe tracking settings for a domain.
40+
41+
`mailgun.domains({domain}).tracking().unsubscribe().update({attributes}, {callback});`
42+
43+
Method | Path
44+
--- | ---
45+
PUT | /domains/{domain}/tracking/unsubscribe
46+

0 commit comments

Comments
 (0)