From f86312bf3cbacae46f8e8d8fa8f782d0b65c348c Mon Sep 17 00:00:00 2001 From: Bojan Djurkovic Date: Thu, 19 Apr 2018 20:55:55 -0300 Subject: [PATCH] update docs --- docs/api/tags.md | 40 ++++++++++++++++++++++++++++++++++++++ docs/api/tracking.md | 46 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 86 insertions(+) create mode 100644 docs/api/tracking.md diff --git a/docs/api/tags.md b/docs/api/tags.md index 30ffd56..109f699 100644 --- a/docs/api/tags.md +++ b/docs/api/tags.md @@ -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. diff --git a/docs/api/tracking.md b/docs/api/tracking.md new file mode 100644 index 0000000..0eaaaff --- /dev/null +++ b/docs/api/tracking.md @@ -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 +