Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bojand committed Apr 19, 2018
1 parent abe09bd commit f86312b
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/api/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,46 @@ Method | Path
--- | ---
GET | /{domain}/tags/{tag}

### `info`

Returns statistics for a given tag.

`mailgun.tags({tag}).stats().info({callback});`

Method | Path
--- | ---
GET | /{domain}/tags/{tag}/stats

### `list`

Returns a list of countries of origin for a given domain for different event types.

`mailgun.tags({tag}).stats().aggregates().countries().list({callback});`

Method | Path
--- | ---
GET | /{domain}/tags/{tag}/stats/aggregates/countries

### `list`

Returns a list of email providers for a given domain for different event types.

`mailgun.tags({tag}).stats().aggregates().providers().list({callback});`

Method | Path
--- | ---
GET | /{domain}/tags/{tag}/stats/aggregates/providers

### `list`

Returns a list of devices for a given domain that have triggered event types.

`mailgun.tags({tag}).stats().aggregates().devices().list({callback});`

Method | Path
--- | ---
GET | /{domain}/tags/{tag}/stats/aggregates/devices

### `delete`

Deletes all counters for particular tag and the tag itself.
Expand Down
46 changes: 46 additions & 0 deletions docs/api/tracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# tracking

Programmatically get and modify domain tracking settings.

## Actions

### `info`

Returns tracking settings for a domain.

`mailgun.domains({domain}).tracking().info({callback});`

Method | Path
--- | ---
GET | /domains/{domain}/tracking

### `update`

Updates the open tracking settings for a domain.

`mailgun.domains({domain}).tracking().open().update({attributes}, {callback});`

Method | Path
--- | ---
PUT | /domains/{domain}/tracking/open

### `update`

Updates the click tracking settings for a domain.

`mailgun.domains({domain}).tracking().click().update({attributes}, {callback});`

Method | Path
--- | ---
PUT | /domains/{domain}/tracking/click

### `update`

Updates the unsubscribe tracking settings for a domain.

`mailgun.domains({domain}).tracking().unsubscribe().update({attributes}, {callback});`

Method | Path
--- | ---
PUT | /domains/{domain}/tracking/unsubscribe

0 comments on commit f86312b

Please sign in to comment.