DayPI: Search Calls

search_getRelatedArticles - Get articles that contain the given query term
search_getMatchingTopics - Get topics with names matching the given query term
search_getRelatedTopics - Get topics mentioned in articles that contain the given query term
search_getRelatedQuotes - Get quotes from articles that contain the given query term
search_getQuotesAbout - Get quotes that contain the given query term
search_getRelatedImages - Get images whose captions contain the given query term
search_getCounts - Get number of articles that mention the given query term

The Search API methods return search results containing related articles, quotes, images and topics for a given query term.

search_getRelatedArticles

Returns articles that contain the given query term. (See section/appendix on search query syntax.)

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getRelatedArticles?accesskey=<accesskey>&signature=<signature>&query=Condoleezza+Iraq

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	Iraq war	N/A
end_time		Timestamp	N	2007-03	<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800	<end_time minus 1 month>
limit	The number of results to be returned	integer	N	40	10
offset		integer	N	5	0
sort		string	N	date, relevance	date
source_filter_id		string	N	06T8a8lavf8sc	None
include_scores	Flag to indicate if enhanced score data be included for every article if available.	integer	N	0 or 1	0

Sample Output:

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<article>
			<timestamp_epoch type="int4">1200682287</timestamp_epoch>
			<source>
				<name type="str">Associated Press</name>
				<url type="str">http://hosted.ap.org/</url>
				<daylife_url type="str">http://www.daylife.com/source/Associated_Press</daylife_url>
				<rank type="int4">1</rank>
				<source_id type="str">0f279rG8jo3Is</source_id>
				<type type="int4">1</type>
			</source>
			<headline type="str">Sunni Sheik Offers Guns and Gets Rewards</headline>
			<timestamp type="str">2008-01-18 18:51:27</timestamp>
			<related_article_count type="int4">13</related_article_count>
			<excerpt type="str">They know him as the sheik. But what that really means in this Sunni town 
				is a bit of everything: community leader, public works supervisor, agricultural planner, 
				militia captain.
			</excerpt>
			<url type="str">http://hosted.ap.org/dynamic/stories/I/IRAQ_SHEIKS_BARGAIN?SITE=TNKNN</url>
			<daylife_url type="str">http://www.daylife.com/article/03j9fqr8kkb6B</daylife_url>
			<article_id type="str">03j9fqr8kkb6B</article_id>
			<scores>
				<newsdomain type="str">World</newsdomain>
				<op-ed type="int4">5</op-ed>
				<spinometer type="int4">-5</spinometer>
			</scores>
		</article>
		........
		........
	</payload>
</response>

search_getMatchingTopics

This method is used to retrieve references to Daylife topics whose names match with the given query term. For example, to find the Condoleezza Rice topic, you could use query=Condoleezza.

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getMatchingTopics?
accesskey=<accesskey>&signature=<signature>&query=United&include_image=1

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	Laura+Bush	N/A
limit	the number of results to be returned	integer	N	40	10
offset		integer	N	5	0
include_image	Flag that indicates if a thumbnail image for each topic should be returned if available.	integer	N	0 or 1	0

Sample Output:

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<topic>
			<topic_id type="str">0dVm3LAbhJbES</topic_id>
			<type type="str">PLACE</type>
			<name type="str">United States</name>
			<daylife_url type="str">http://www.daylife.com/topic/United_States</daylife_url>
			<image>
				<url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/45x45.jpg</url>
				<daylife_url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/340x.jpg</daylife_url>
				<thumb_url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/45x45.jpg</thumb_url>
				<timestamp_epoch type="int4">1177281949</timestamp_epoch>
				<timestamp type="str">2007-04-22 22:45:49</timestamp>
				<credit type="str">AFP/Getty Images</credit>
				<image_topic_relevance type="int4">10</image_topic_relevance>
				<width type="int4">2860</width>
				<height type="int4">2268</height>
				<image_id type="str">0gwb63H2Wmapg</image_id>
				<caption type="str">
					Vania King of the US (L) speaks with US team captain Zena Garrison (R) 
					during a break in her match against Kirsten Flipken of Belgium in the 
					quarter-finals round in the Fed Cup World Group 2007 between Belgium and 
					the US in Delray Beach, Florida 22 April 2007. King won the match 4-6, 
					6-4, 7-5 to give the US a total score of 3-0 and move to the next round
				</caption>
				<source>
					<name type="str">Getty Images</name>
					<url type="str">http://gettyimages.com/</url>
					<daylife_url type="str">http://www.daylife.com/source/Getty_Images</daylife_url>
					<rank type="int4">1</rank>
					<source_id type="str">0a9L9fsaU55wK</source_id>
					<type type="int4">6</type>
				</source>
			</image>
		</topic>
		........
		........
	</payload>
</response>

search_getRelatedTopics

This method is used to retrieve references to Daylife topics that have appeared in articles containing the given query term. To find specifically named topics, use the search_getMatchingTopics method call.

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getRelatedTopics?
accesskey=<accesskey>&signature=<signature>&query=United&include_image=1

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	Iraq	N/A
end_time		Timestamp	N	2007-03	<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800	<end_time minus 1 month>
limit	the number of results to be returned	integer	N	40	10
offset		integer	N	5	0
sort	flag to indicate the sorting order	string	N	date, relevance	date
source_filter_id	daylife source filter id	string	N	06T8a8lavf8sc	None
include_topic_type	one or more name value pairs indicating which sorts of topics you wish to include	string	N	person or place or organization	person,place,organization
include_image	Flag that indicates if a thumbnail image for each topic should be returned if available.	integer	N	0 or 1	0

Sample Output

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<topic>
			<topic_id type="str">0dVm3LAbhJbES</topic_id>
			<type type="str">PLACE</type>
			<name type="str">United States</name>
			<daylife_url type="str">http://www.daylife.com/topic/United_States</daylife_url>
			<image>
				<url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/45x45.jpg</url>
				<daylife_url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/340x.jpg</daylife_url>
				<thumb_url type="str">http://cache.daylife.com/imageserve/0gwb63H2Wmapg/45x45.jpg</thumb_url>
				<timestamp_epoch type="int4">1177281949</timestamp_epoch>
				<timestamp type="str">2007-04-22 22:45:49</timestamp>
				<credit type="str">AFP/Getty Images</credit>
				<image_topic_relevance type="int4">10</image_topic_relevance>
				<width type="int4">2860</width>
				<height type="int4">2268</height>
				<image_id type="str">0gwb63H2Wmapg</image_id>
				<caption type="str">
					Vania King of the US (L) speaks with US team captain Zena Garrison (R) 
					during a break in her match against Kirsten Flipken of Belgium in the 
					quarter-finals round in the Fed Cup World Group 2007 between Belgium and 
					the US in Delray Beach, Florida 22 April 2007. King won the match 4-6, 
					6-4, 7-5 to give the US a total score of 3-0 and move to the next round
				</caption>
				<source>
					<name type="str">Getty Images</name>
					<url type="str">http://gettyimages.com/</url>
					<daylife_url type="str">http://www.daylife.com/source/Getty_Images</daylife_url>
					<rank type="int4">1</rank>
					<source_id type="str">0a9L9fsaU55wK</source_id>
					<type type="int4">6</type>
				</source>
			</image>
		</topic>
		........
		........
	</payload>
</response>

search_getRelatedQuotes

This method is used to retrieve quotes from articles that contain the given query term .

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getRelatedQuotes?
accesskey=<accesskey>&signature=<signature>&query=Condoleezza+Iraq&limit=1

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	pentagon	N/A
end_time		Timestamp	N	2007-03	<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800	<end_time minus 1 month>
limit	the number of results to be returned	integer	N	40	10
offset		integer	N	5	0
sort	flag to indicate the sorting order	string	N	date, relevance	date
source_filter_id	daylife source filter id	string	N	06T8a8lavf8sc	None
require_speaker	flag specifying the quotes returned must be attributed (i.e., the speaker is known)	integer	N	0 or 1	0
speaker_topic_id	topic_ids of topics that the quotes returned must be attributed to	string	N	name-value pairs of topic_ids	None

Sample Output

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<quote>
			<quote_id type="str">03TWezQa1M85p</quote_id>
			<timestamp_epoch type="int4">1200749352</timestamp_epoch>
			<timestamp type="str">2008-01-19 13:29:12</timestamp>
			<quote_text type="str">But we will still be friends with the 
						Americans and invite them to tea every 
						time they drive through the town
			</quote_text>
			<source>
				<name type="str">MSNBC</name>
				<url type="str">http://www.msnbc.msn.com/</url>
				<daylife_url type="str">http://www.daylife.com/source/MSNBC</daylife_url>
				<rank type="int4">1</rank>
				<source_id type="str">07yTb3kbhD6Bo</source_id>
				<type type="int4">1</type>
			</source>
			<daylife_url type="str">http://www.daylife.com/quote/03TWezQa1M85p</daylife_url>
			<article>
				<timestamp_epoch type="int4">1200749352</timestamp_epoch>
				<headline type="str">'Awakening' pacts prove complicated</headline>
				<timestamp type="str">2008-01-19 13:29:12</timestamp>
				<url type="str">http://www.msnbc.msn.com/id/22739412/</url>
				<daylife_url type="str">http://www.daylife.com/article/0baOdqcflg2hB</daylife_url>
				<article_id type="str">0baOdqcflg2hB</article_id>
			</article>
		</quote>
		........
		........
	</payload>
</response>

search_getQuotesAbout

This method is used to retrieve quotes that mention a given query term .

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getQuotesAbout?
accesskey=<accesskey>&signature=<signature>&query=Condoleezza&limit=1

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	pentagon	N/A
end_time		Timestamp	N	2007-03	<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800	<end_time minus 1 month>
limit	the number of results to be returned	integer	N	40	10
offset		integer	N	5	0
sort	flag to indicate the sorting order	string	N	date, relevance	date
source_filter_id	daylife source filter id	string	N	06T8a8lavf8sc	None
require_speaker	flag specifying the quotes returned must be attributed (i.e., the speaker is known)	integer	N	0 or 1	0
speaker_topic_id	topic_ids of topics that the quotes returned must be attributed to	string	N	name-value pairs of topic_ids	None

Sample Output

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<quote>
			<quote_id type="str">03TWezQa1M85p</quote_id>
			<timestamp_epoch type="int4">1200749352</timestamp_epoch>
			<timestamp type="str">2008-01-19 13:29:12</timestamp>
			<quote_text type="str">But we will still be friends with Condoleezza
						and invite them to tea every time they drive through the town
			</quote_text>
			<source>
				<name type="str">MSNBC</name>
				<url type="str">http://www.msnbc.msn.com/</url>
				<daylife_url type="str">http://www.daylife.com/source/MSNBC</daylife_url>
				<rank type="int4">1</rank>
				<source_id type="str">07yTb3kbhD6Bo</source_id>
				<type type="int4">1</type>
			</source>
			<daylife_url type="str">http://www.daylife.com/quote/03TWezQa1M85p</daylife_url>
			<article>
				<timestamp_epoch type="int4">1200749352</timestamp_epoch>
				<headline type="str">'Awakening' pacts prove complicated</headline>
				<timestamp type="str">2008-01-19 13:29:12</timestamp>
				<url type="str">http://www.msnbc.msn.com/id/22739412/</url>
				<daylife_url type="str">http://www.daylife.com/article/0baOdqcflg2hB</daylife_url>
				<article_id type="str">0baOdqcflg2hB</article_id>
			</article>
		</quote>
		........
		........
	</payload>
</response>

search_getRelatedImages

This method is used to retrieve images related to articles that contain the given query term

This API returns any results only when a source filter for image sources is supplied due to image licensing restrictions. Please email developer@daylife.com for more information on image licensing.

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getRelatedImages?
accesskey=<accesskey>&signature=<signature>&query=Condoleezza+Iraq&limit=2

Input Parameters

Name	Description	Type	Required		Sample Values	Default Value
accesskey		string	Y	<your_access_key>		N/A
signature		string	Y	<calculated_signature>		N/A
query	the search term	string	Y	bush		N/A
end_time		Timestamp	N	2007-09-24 00:00:00		<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800		<end_time minus 1 month>
limit	the number of results to be returned	integer	N	40		10
offset		integer	N	5		0
sort	flag to indicate the sorting order	string	N	date, relevance		Date
source_filter_id	daylife source filter id	string	N	06T8a8lavf8sc		None

Sample Output

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<image>
			<url type="str">http://cache.daylife.com/imageserve/0dDR845cPSa7m/610x.jpg</url>
			<daylife_url type="str">http://cache.daylife.com/imageserve/0dDR845cPSa7m/340x.jpg</daylife_url>
			<thumb_url type="str">http://cache.daylife.com/imageserve/0dDR845cPSa7m/45x45.jpg</thumb_url>
			<timestamp_epoch type="int4">1200582120</timestamp_epoch>
			<timestamp type="str">2008-01-17 15:02:00</timestamp>
			<image_id type="str">0dDR845cPSa7m</image_id>
			<image_topic_relevance type="int4">10</image_topic_relevance>
			<width type="int4">3000</width>
			<height type="int4">1915</height>
			<caption type="str">
				US President George W. Bush (C) meets with the Special Envoy for Sudan, 
				Richard Williamson (L) and Secretary of State Condoleezza Rice (R), in the Oval 
				Office at the White House in Washington, DC, 17 January 2008.
			</caption>
			<credit type="str">AFP/Getty Images</credit>
			<source>
				<name type="str">Getty Images</name>
				<url type="str">http://gettyimages.com/</url>
				<daylife_url type="str">http://www.daylife.com/source/Getty_Images</daylife_url>
				<rank type="int4">1</rank>
				<source_id type="str">0a9L9fsaU55wK</source_id>
				<type type="int4">6</type>
			</source>
		</image>
		....
		....
	</payload>
</response>

search_getCounts

This method is used to retrieve number of mentions in news for the given query

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/search_getCounts?
accesskey=<accesskey>&signature=<signature>&query=Condoleezza

Input Parameters

Name	Description	Type	Required	Sample Values	Default Value
accesskey		string	Y	<your_access_key>	N/A
signature		string	Y	<calculated_signature>	N/A
query	the search term	string	Y	Laura+Bush	N/A
end_time		Timestamp	N	2007-03	<current time>
start_time		Timestamp	N	2007-05-03 09:00:00, 1178182800	<end_time minus 1 month>
source_filter_id	string	N	06T8a8lavf8sc	None	N/A

Sample Output:

<response>
	<message type="str">Success</message>
	<code type="int4">2001</code>
	<payload>
		<count type="int4">1232</count>
	</payload>
</response>

About the Cookbook

Login to the Cookbook

Resources

Featured Recipes

Popular Tags

Testimonials

search_getRelatedArticles

search_getMatchingTopics

search_getRelatedTopics

search_getRelatedQuotes

search_getQuotesAbout

search_getRelatedImages

search_getCounts