api.service.search.doEmailSearch

api.service.search::doEmailSearch

Searches the EDS Email Archive for the specified term(s). This method supports constraining the results by market sector.

Service

api.service.search

Arguments

api-key (Required) : Your API application key.

term (Optional): The search term(s) you would like to search for. To limit the search to specific domains simply specify the domain within the search term. Multiple search terms can be searched by separating search terms with a space. Wildcards using * and + are supported.

search-mode (Optional): subject, body or both (default). Specifies whether the subject, body or both should be searched for the specified term.

start (Optiona): Constrains the search results based upon the specified start datetime. Format: YYYYMMDDHHMMSS

end (Optional): Constrains the search results based upon the specified end datetime. Format: YYYYMMDDHHMMSS. NOTE: If you specify an end time you must also specify a start time

market (Optional): Constrains the search results to the specified market sector. This field supports wildcards *.

sending-domain (Optional): Constrains the search results to the specified sending domain. This field does not support wildcard matches

ipaddress (Optional): Constrains the search results to the specified sending ip address.
Valid Formats:
nnn.nnn.nnn.nnn
nnn.nnn.nnn. (1 period)
nnn.nnn.. (2 periods)
nnn... (3 periods)

redirect-domain (Optional): Constrains the search results to the results containing the specified redirect domain. Must be a valid domain format
When combined with the site-domain parameter, this will limit the search results that have redirects that ultimatley land on the specified site-domain.

aid (Optional): Searches the redirect URLs for the specified string. For example, this parameter can be used to search for affiliate ids within the redirect URLs.
NOTES: The aid parameter requires that at least one other parameter be specified as well. (such as redirect domain, site domain, date range, etc)
               We currently have 220 million (and growing :) redirect URLs stored in our database from May 2009 onward.  

site-domain (Optional) : Constrains the search results to the resuilts containing the specified site domains. Must be a valid domain
When combined with the redirect-domain parameter, this will limit the search results to those having redirects that ultimately land at this site domain

include-data (Optional): 1 (default) or 0.  Determines whether the search results will include the subject and from-domain in the response. If the data is included, the responses are limited to 256 results. If the data is not included, the responses are limited to 2000 results.

Example Response

Request:
http://api.emaildatasource.com/service/2.0.0/rest/api.service.search?method=doEmailSearch&include-data=0&term=llbean&start=20090101000000&end=20090320205959

<?xml version="1.0" encoding="utf-8"?>
<response status="success">
<format>rest-xml</format>
<version>2.0</version>
<search-results>
<num-results>4</num-results>
<uuid-request-url>http://mashery-api.emaildatasource.com/ea3-api/service/2.0.0/rest/api.service.email?method=getEmails&uuid={uuid}&include-all=1&per_page=25</uuid-request-url>
<uuid-list>
<uuid datetime="20090307">3fb447f9-ea82-4294-abb8-3d68850c88ce</uuid>
<uuid datetime="20090211">0c150093-fd8b-4bd5-a0e9-24a56939c819</uuid>
<uuid datetime="20090211">209f492d-3acb-4aca-8a9c-f71eae011843</uuid>
<uuid datetime="20090120">7ba75b52-ade9-4546-a719-e063fec75488</uuid>
</uuid-list>
</search-results>
</response>

Error Codes

440: Too Many Results: The search returned too many results

441: Invalid Search Parameter: One of the specified search parameters was invalid
442: Invalid Search Query: The search query (term) is not valid