GET api/v1/search/publishedarticles/related?publication={publication}&categoryId={categoryId}&parentCategoryId={parentCategoryId}&isCloaked={isCloaked}&userArticleId={userArticleId}&next={next}&pageSize={pageSize}&locale={locale}&isVideo={isVideo}&publishedAt={publishedAt}&date={date}

Get articles related to the given data

Request Information

URI Parameters

NameDescriptionTypeAdditional information
publication

Publication name to match

string

Required

categoryId

Sub-Category ID to match

string

Required

parentCategoryId

Parent-Category ID to match

string

Required

isCloaked

Filter by cloaked or not-cloaked

boolean

Required

userArticleId

The id of the original user article object

string

None.

next

Token given from first request that specifies where to continue getting more. If not specified, gets the most recent items.

integer

None.

pageSize

The maximum number of items to return. Defaults to 10.

integer

None.

locale

Locale to use to filter the feed with. E.g. en, fr, es. Defaults to "us".

string

None.

isVideo

whether or not the current article is a video article.

boolean

None.

publishedAt

date

None.

date

date

None.

Body Parameters

None.

Response Information

Resource Description

LinkedDataOfFeedItem
NameDescriptionTypeAdditional information
Items

Collection of FeedItem

None.

Next

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Items": [
    {
      "Type": "ArticleCard",
      "Item": {}
    },
    {
      "Type": "ArticleCard",
      "Item": {}
    }
  ],
  "Next": "sample string 1"
}

application/xml, text/xml

Sample:
<LinkedDataOfFeedItemDj8flMKB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoViral.Data.Models">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Feed.Core.Models">
    <d2p1:FeedItem>
      <d2p1:Item />
      <d2p1:Type>ArticleCard</d2p1:Type>
    </d2p1:FeedItem>
    <d2p1:FeedItem>
      <d2p1:Item />
      <d2p1:Type>ArticleCard</d2p1:Type>
    </d2p1:FeedItem>
  </Items>
  <Next>sample string 1</Next>
</LinkedDataOfFeedItemDj8flMKB>