Youneeq Search Reference Material

Request search results for the given domain and search terms.

HTTP Request

GET http://search.youneeq.ca/api/search?callback=&json=

Query Parameters

Parameter  

Type  

Required  

Description

callback

string

The JQuery callback ID. This should be added automatically via a JQuery Ajax request.

json

json

See JSON Parameters.

JSON Parameters

Parameter

Type

Required  

Description

domain

string

The domain to get search results from and use user history from to personalize those results.

search

string

The search string inputted by the user. Can include multiple words, spaces, etc. Will be parsed server-side.

userId

string

 

The user’s ID. Known as bof_profile in the recommendation service. If not supplied, search results will not be personalized.

contentInfo

boolean

 

Whether to include the content information (title, description, url, image) with the search results. Defaults to true.

endDate

string

 

The most recent publish date of articles to include in the search results. The format must be supported by .NET’s DateTime.TryParse.

maxArticleAge

integer

 

The maximum age (in days) of articles that should be included in the search results.

personalized

boolean

 

If true, search results will be personalized for the user.

pageNumber

integer

  

startDate

string

 

The oldest publish date of articles to include in the search results. The format must be supported by .NET’s DateTime.TryParse.

killPromoteInfo

boolean

 

Whether to include the kill/promote status of the individual search results. Defaults to false. Currently dependent on contentInfo, i.e. if contentInfo is false, this will always be false.

Sample Request

GET http://search.youneeq.ca/api/search?callback=jQuery17109329779187683022_1454095328422&json={“domain”:”mydomain.com”,”search”:”zika virus”,”userId”:”2vcwxogpr4oxvbotfbdbrl0o”,”contentInfo”:”false”}

Parameter  Type    Description
storiesarrayAn array of objects, where each object represents one article in the search results. The array is sorted by score, with the articles at the beginning of the array being more relevant than those at the end of the array.
numResults  integer