inboxtracker.postmaster_tools.yahoo

class inboxtracker.postmaster_tools.Yahoo(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
get_domain_perf(**kwargs)

Get Yahoo Performance data rolled up at the domain level.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: domain, -domain, inboxVolume, -inboxVolume, spamVolume, -spamVolume, folderVolume, -folderVolume, errorVolume, -errorVolume, totalComplaints, -totalComplaints.

    Defaults to -inboxVolume.

Returns

A list object of dict containing deliverability performance data.

get_ip_perf(**kwargs)

Get Yahoo Performance data grouped by IP address.

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • ipAddress – List of strings. IP addresses to filter on.

  • onlyComplaintErrorIps (bool) – Only return IPs that have errorVolume or totalComplaints greater than zero for the period given.

  • page (int) – The page to query for in pagination.

  • per_page (int) – The amount of records per page you wish to query for (max 100)

  • order (str) –

    The property to sort by (‘property’ for decending, ‘-property’ for ascending)

    Accepts: ipAddress, -ipAddress, inboxVolume, -inboxVolume, spamVolume, -spamVolume, folderVolume, -folderVolume, errorVolume, -errorVolume, totalComplaints, -totalComplaints

Returns

A list object of dict containing deliverability performance data.

get_volume_over_time(**kwargs)

Volume over time for Yahoo Performance data grouped by the default grouping period:

HOUR when <= 7d

DAY when <= 31d

WEEK when <= 182d

MONTH when > 182d

Parameters

  • qd (str) –

    A date range query parameter.

    Accepts: since:YYYYMMDD, between:YYYYMMDDhhmmss,YYYYMMDDhhmmss, and daysBack:N.

    Examples: since:20190601, between:20191001000000,20191002060000, daysBack:30

  • domain – List of strings. The domains to filter on.

  • sourceFilter –

    List of strings. The sources to use for inbox percentages.

    Accepts: PANEL, INTELLISEED

    Defaults to all.

Returns

A list object of dict containing volume data.

inboxtracker.postmaster_tools.ping

class inboxtracker.postmaster_tools.Ping(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
ping_service()

Ping the service to verify it is reachable.

Returns

A str object. A successful ping will return the string ‘pong’.