competitivetracker.search

class competitivetracker.search.Search(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

search(**kwargs)

Search for campaigns with many different criteria. Detected sending or forwarding IPs are accessible via the sendingIps embed option.

Parameters

• qd (str) –

  (Required) A date range query parameter.

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

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

• subject (str) – Subject search criteria

• body (str) – Body search criteriaSubject search criteria

• campaignLengthFilter (str) –

  Length filter in days for the campaign

  Examples: >,2, <,5, =,1

• sendingDomain – List of strings. Filter search to specific sending domains (multiple allowed)

• excludeSendingDomain – List of strings. Filter out specific sending domains (multiple allowed)

• brandId – List of int. Filter search to specific brands (multiple allowed)

• excludedBrandId – List of int. Filter out specific brands (multiple allowed)

• companyId – List of int. Filter search to specific companies (multiple allowed)

• excludedCompanyId – List of int. Filter out specific companies (multiple allowed)

• industryId – List of int. Filter search to specific industries (multiple allowed)

• sentFrom (str) – Campaigns with a matching sent from address

• fromAddress – List of strings. Campaigns with certain from addresses (multiple allowed)

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

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

• receivedUsingMta (str) – Campaigns were received using a matched MTA

• mobileReady (bool) – Campaigns with/without mobile ready format

• hasCreative (bool) – Campaigns with/without creatives

• onlyCommercial (bool) – True for commercial campaigns, False for daily low-volume rollups, and leave unset (null) for both

• emojiPresent (bool) – Campaigns with/without emojis in the subject

• readPercentage (str) –

  Read percentage filter

  Examples: >,20, <,5, =,2

• readDeletedPercentage (str) –

  Read+Deleted percentage filter

  Examples: >,20, <,5, =,2

• deletedPercentage (str) –

  Deleted percentage filter

  Examples: >,20, <,5, =,2

• inboxPercentage (str) –

  Inbox percentage filter

  Examples: >,20, <,5, =,2

• spamPercentage (str) –

  Spam percentage filter

  Examples: >,20, <,5, =,2

• projectedVolumeFilter (str) –

  Projected Total Volume filter

  Examples: >,2000000, <,50000, =,324541

• secondaryProjectedVolumeFilter (str) –

  Secondary Projected Total Volume filter

  Examples: >,2000000, <,50000, =,324541

• droveTrafficToDomain – List of strings. Filter search to campaigns that drive traffic to certain domains (multiple allowed)

• sendFromIp – List of strings. Filter search to campaigns that were sent from certain ips (multiple allowed)

• espId (int) – Filter search to a specific ESP

• espStartIp (str) – The start IP of the sending ESP

• espEndIp (str) – The end IP of the sending ESP

• espRedirectDomain (str) – The redirect domain of the sending ESP

• espRedirectString (str) – The match the redirect string of the sending ESP

• campaignTargetCountry – List of strings. Filter search to campaigns with a specific target country code (multiple allowed)

• excludedCampaignTargetCountry – List of strings. Filter out campaigns with a specific target country code (multiple allowed)

• 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 descending, ‘-property’ for ascending)

  Accepts: firstSeen, -firstSeen, lastSeen, -lastSeen, inbox, -inbox, spam, -spam

• embed (str) –

  The objects within the return model you wish to embed in the form of ‘customer, customer.name, etc’

  Accepts: sendingIps, rawEmail, ispPlacements, links, headers (headers is only available for ESP-owned accounts).

Returns

A list of object dict containing campaign details.