GetEntityRelatedArticles Method
Uri: https://magnetapi.klangoo.com/NewsAgencyService.svc/GetEntityRelatedArticles
Parameters:
|
Calk |
A string containing the api key |
|
entityID |
A string representing the entity identifier to search (use either entityID or entityToken) |
|
entityToken |
A string representing the entity token to search (use either entityID or entityToken) |
|
category |
(optional) A string representing the search domain. If parameter not set then all categories are searched. · “General” · “Business” · “Law Enforcement” · “Entertainment” · “Health” · “Politics” · “Science” · “Sports” · “Technology” |
|
orderBy |
(optional) order related documents 0 – order desc by relevancy (Default) 1 – order desc by date |
|
showDetails |
(optional) Show related documents details. 0 – show docID, articleUID, score, rank, insertDate (Default) 1 – showDetails=0 plus title, url, source, lang 2 – showDetails=1 plus snippet 3 – showDetails=0 plus images 4 – showDetails=2 plus images |
|
filterDate |
(optional) Filter document added before filterDate. Format: “dd MMM yyyy HH':'mm':'ss zzzz“, “dd MMM yyyy zzzz” Examples: “20 OCT 2011 05:30:00 GMT”, : “20 OCT 2011 05:30:00 Z”,“20 OCT 2011 05:30:00 +03:00”, “20 OCT 2011 GMT”, “20 OCT 2011 +08:00” |
|
source |
(optional) A string representing the source filter. Multiple sources are separated by ‘,’. If parameter not set then all sources are used. |
|
language |
(optional) A string representing the language filter. Multiple languages are separated by ‘,’. If parameter not set then all languages are used. |
|
maxReturnRows |
(optional) Maximum number of related documents to return. |
|
relevancy |
(optional) A string representing the relevancy filter (by default ‘SR’): VR: only Very Related articles are returned R: Related & Very Related articles are returned SR: Somewhat Related, Related and Very Related articles are returned |
|
page |
(optional) An integer that represents the page number. The first page is 0. The page size is defined by the maxReturnRows parameter. |
|
format |
(optional)The format of the response. The supported formats are “xml” and “json”. Default: “xml” |
|
timestamp |
(optional) required if ‘authenticate read’ is activated |
|
signature |
(optional) required if ‘authenticate read’ is activated |
Response:
|
XML tag |
Description |
|
status |
Indicates the status of the response. Possible values “OK” and “ERROR” |
|
error |
Indicates an error if one occurred |
|
quota |
Indicates the number of remaining calls for this CALK |
|
relDocCount |
Related Content (article, video) Count provided as per the request |
|
availableRows |
Related Content (article, video) available rows count for the request when page is used. |
|
relatedDocuments |
Related Content (article, video) identified automatically by Magnet |
|
relDoc |
Related Content |
|
docID |
Magnet unique Content id |
|
rank |
Magnet relevancy criteria: VR: very related R: related SR: somewhat related |
|
insertDate |
Content insert date |
|
title |
Content title |
|
url |
Content url |
|
source |
Content source |
|
snippet |
Short passage from the content retrieved |
|
images |
Images related to the content |
|
lang |
Content language identified |
Comments
0 comments
Article is closed for comments.