inboxtracker.campaigns

class inboxtracker.campaigns.Campaigns(base_uri, api_key, transport_class=<class 'inboxtracker.base.RequestsTransport'>)
get_campaign_by_id(campaignId, **kwargs)

Get campaign details by querying campaign identifier.

Parameters

  • campaignId (int) – Integer campaign identifier

  • childAccountId (int) – The child account to narrow results

  • embed (str) –

    The objects within the return model you wish to embed.

    Accepts: sendingIps, gmailCategories, authInbox

Returns

A dict object containing details of the specified campaign.

get_campaigns(**kwargs)

Get all campaign details for a given time period

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

  • campaignIdentifier (str) – The campaign identifier value to search for.

  • fromAddress (str) – The from address to search for

  • childAccountId (int) – The child account to narrow results

  • domain – List of strings. Narrow results to certain domains that are under this API key (multiple allowed)

  • headerKey (str) – Campaigns that used a specific header key

  • headerValue (str) – Campaigns that used a specific header value

  • subject (str) – Subject search criteria

  • body (str) – Body search criteria

  • 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: firstSeen, -firstSeen, lastSeen, -lastSeen, inbox, -inbox, spam, -spam

  • embed (str) –

    The objects within the return model you wish to embed.

    Accepts: sendingIps, gmailCategories, authInbox

Returns

A list object of dict containing details for a campaign.

get_ip_stats(**kwargs)

Get statistics for all IP addresses in your account

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

  • childAccountId – List of int. The child account(s) to narrow results

  • ipAddress – List of strings. The ip address to narrow results to (multiple allowed)

  • domain – List of strings. Narrow results to certain domains that are under this API key (multiple allowed)

  • limitToSpecifiedDomains (bool) – Only include data for the supplied domains (vs all domains using the IPs)

  • 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)

Returns

A list object of dict containing campaign details for each IP address.