Urls
in package
Manage your tracking domains. Some of these endpoints may be deprecated.
Table of Contents
Properties
- $master : mixed
Methods
- __construct() : mixed
- addTrackingDomain() : struct
- Add a tracking domain to your account.
- checkTrackingDomain() : struct
- Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.
- getList() : array<string|int, mixed>
- Get the 100 most clicked URLs.
- search() : array<string|int, mixed>
- Return the 100 most clicked URLs that match the search query given.
- timeSeries() : array<string|int, mixed>
- Return the recent history (hourly stats for the last 30 days) for a url.
- trackingDomains() : array<string|int, mixed>
- Get the list of tracking domains set up for this account.
Properties
$master
public
mixed
$master
Methods
__construct()
public
__construct(Client $master) : mixed
Parameters
- $master : Client
addTrackingDomain()
Add a tracking domain to your account.
public
addTrackingDomain(string $domain) : struct
Parameters
- $domain : string
-
a domain name
Return values
struct —information about the domain
- domain string the tracking domain name
- created_at string the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
- cname struct details about the domain's CNAME record
- valid boolean whether the domain's CNAME record is valid for use with Mandrill
- valid_after string when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
- error string an error describing the CNAME record, or null if the record is correct
- valid_tracking boolean whether this domain can be used as a tracking domain for email.
checkTrackingDomain()
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.
public
checkTrackingDomain(string $domain) : struct
Parameters
- $domain : string
-
an existing tracking domain name
Return values
struct —information about the tracking domain
- domain string the tracking domain name
- created_at string the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
- cname struct details about the domain's CNAME record
- valid boolean whether the domain's CNAME record is valid for use with Mandrill
- valid_after string when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
- error string an error describing the CNAME record, or null if the record is correct
- valid_tracking boolean whether this domain can be used as a tracking domain for email.
getList()
Get the 100 most clicked URLs.
public
getList() : array<string|int, mixed>
Return values
array<string|int, mixed> —the 100 most clicked URLs and their stats
- return[] struct the individual URL stats
- url string the URL to be tracked
- sent integer the number of emails that contained the URL
- clicks integer the number of times the URL has been clicked from a tracked email
- unique_clicks integer the number of unique emails that have generated clicks for this URL
search()
Return the 100 most clicked URLs that match the search query given.
public
search(string $q) : array<string|int, mixed>
Parameters
- $q : string
-
a search query
Return values
array<string|int, mixed> —the 100 most clicked URLs matching the search query
- return[] struct the URL matching the query
- url string the URL to be tracked
- sent integer the number of emails that contained the URL
- clicks integer the number of times the URL has been clicked from a tracked email
- unique_clicks integer the number of unique emails that have generated clicks for this URL
timeSeries()
Return the recent history (hourly stats for the last 30 days) for a url.
public
timeSeries(string $url) : array<string|int, mixed>
Parameters
- $url : string
-
an existing URL
Return values
array<string|int, mixed> —the array of history information
- return[] struct the information for a single hour
- time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format
- sent integer the number of emails that were sent with the URL during the hour
- clicks integer the number of times the URL was clicked during the hour
- unique_clicks integer the number of unique clicks generated for emails sent with this URL during the hour
trackingDomains()
Get the list of tracking domains set up for this account.
public
trackingDomains() : array<string|int, mixed>
Return values
array<string|int, mixed> —the tracking domains and their status
- return[] struct the individual tracking domain
- domain string the tracking domain name
- created_at string the date and time that the tracking domain was added as a UTC string in YYYY-MM-DD HH:MM:SS format
- last_tested_at string when the domain's DNS settings were last tested as a UTC string in YYYY-MM-DD HH:MM:SS format
- cname struct details about the domain's CNAME record
- valid boolean whether the domain's CNAME record is valid for use with Mandrill
- valid_after string when the domain's CNAME record will be considered valid for use with Mandrill as a UTC string in YYYY-MM-DD HH:MM:SS format. If set, this indicates that the record is valid now, but was previously invalid, and Mandrill will wait until the record's TTL elapses to start using it.
- error string an error describing the CNAME record, or null if the record is correct
- valid_tracking boolean whether this domain can be used as a tracking domain for email.