DayPI: Article Calls



article_getRelatedArticles

This method is used to retrieve articles that are related to the given article.

Sample Invocation

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
article_id The article id or a list of name-value pairs of article_ids string if url not provided 03cV5zI2fk03s N/A
url The article url or a list of name-value pairs of article urls string Y if article_id not provided 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_image Flag to indicate if one related scraped image should be returned if available. integer N 0 or 1 0
include_scores Flag to indicate if enhanced score data should 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>
<query_term type="str">07vgers9mJayf</query_term>
<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>


back to top

article_getRelatedQuotes

This method is used to retrieve quotes from articles related to the given article.

Sample Invocation

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
    article_id The article id or a list of name-value pairs of article_ids string if url not provided 03cV5zI2fk03s N/A
    url The article url or a list of name-value pairs of article urls string Y if article_id not provided 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 list of 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>
<query_term type="str">07vgers9mJayf</query_term>
<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>
back to top

article_getRelatedTopics

This method is used to retrieve topics from articles related to the given article.

Sample Invocation

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
article_id The article id or a list of name-value pairs of article_ids string if url not provided 03cV5zI2fk03s N/A
url The article url or a list of name-value pairs of article urls string Y if article_id not provided 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 To be implemented in future. string N date, relevance Date
source_filter_id daylife source filter id string N 06T8a8lavf8sc None
include_topic_type A comma separated list of types of topics that should be returned string N person or place or organization or a comma separated list of any of their combinations 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>

back to top


article_getQuotes

This method is used to retrieve quotes from within the given article.

Sample Invocation

http://freeapi.daylife.com/xmlrest/publicapi/4.2/article_getQuotes?
accesskey=<accesskey>&signature=<signature>&article_id=
07vgers9mJayf&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
    article_id The article id or a list of name-value pairs of article_ids string Y 03cV5zI2fk03s N/A
    url The article url or a list of name-value pairs of article urls string Y if article_id not provided 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 integer N 0 or 1 0
    speaker_topic_id topic_ids of topics that the quotes returned must be attributed to string N Comma separated list of topic_ids for topics 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>
<query_term type="str">07vgers9mJayf</query_term>
<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>
back to top


article_getTopics

This method is used to retrieve topics from within the given article.

Sample Invocation

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
article_id The article id or a list of name-value pairs of article_ids string Y 03cV5zI2fk03s N/A
url The article url or a list of name-value pairs of article urls string Y if article_id not provided N/A
limit The number of results to be returned integer N 40 10
offset integer N 5 0
sort Flag to indicate the sorting order To be implemented in future. string N date, relevance date
include_topic_type A comma separated list of types of topics that should be returned string N person or place or organization or a comma separated list of any of their combinations 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>

back to top


article_getInfo

This method is used to retrieve information about one or more article IDs.

Sample Invocation

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
article_id The article id or a list of name-value pairs of article_ids string if url not provided 03cV5zI2fk03s N/A
url The article url or a list of name-value pairs of article urls string Y if article_id not provided N/A
include_image Flag to indicate if one related scraped image should be returned if available. integer N 0 or 1 0
include_scores Flag to indicate if enhanced score data should 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>
<query_term type="str">07vgers9mJayf</query_term>
<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>


back to top

* Please refer to documentation for signature creation for article calls accepting multiple article ids or article urls as input.