GluedIn | AI enabled short video SDK

selected title

Discover SDK methods

Method	Method detail
getCuratedRails()	Used to fetch the curated rails for discover section.
getCuratedRailDetails()	Used to fetch the details of a rail by passing category id (rail id) parameter.
getSearchSuggestions()	Returns the list of suggested data based on queried keywords.
getSearchedUserList()	Returns the list of suggested users list based on queried keyword.
getSearchedHashtagList()	Returns the list of suggested hashtag list based on queried keyword.
getSearchedChallengesList()	Returns the list of suggested challenges list based on queried keyword.
getHashtagDetails()	It returns the hashtag details and list of videos.
getSearchedChallengesList()	Returns the list of suggested challenges list based on queried keyword.
getChallengesDetails()	It returns the challenges details and list of videos.
getChallengeLeaderBoardDetails()	It returns the leader board details.

For Fetching Rails

API Class : DiscoverInteractor

Method : getCuratedRails()

Used to fetch the curated rails for discover section.

API Request - NA

API Response:
- Response Object : WidgetResponse
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns curation data
For Rail Details

API Class : DiscoverInteractor

Method : getCuratedRailDetails()

Used to fetch the details of a rail by passing category id (rail id) parameter.

API Request:
- Request Parameter : CategoryParams
- categoryId: id of the category fetched from getCuratedRailList() response
- limit: How many results you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : WidgetDetailResponse
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns curation details
For Get Search Suggestions

API Class : DiscoverInteractor

Method : getSearchSuggestions()

Returns the list of suggested data based on queried keywords.

API Request:
- Request Object : DiscoverRequest
- Parameters
- search : search keyword
- categoryId: empty in this case
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : AllVideoInfo
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns video and hashtag list
For Searching User

API Class : DiscoverInteractor

Method : getSearchedUserList()

Returns the list of suggested users list based on queried keyword.

API Request:
- Request Object : DiscoverRequest
- Parameters
- search : search keyword
- categoryId: empty in this case
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : DiscoverInfo
- Message: It is a simple string message
- StatusCode : It returns api status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns user list
For Searching Hashtags

API Class : DiscoverInteractor

Method : getSearchedHashtagList()

Returns the list of suggested hashtag list based on queried keyword.

API Request:
- Request Object : DiscoverRequest
- Parameters
- Search : search keyword
- categoryId: empty in this case
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : DiscoverHashtagInfo
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it return hashtag list
For Searching Challenges

API Class : DiscoverInteractor

Method : getSearchedChallengesList()

Returns the list of suggested challenges list based on queried keyword.

API Request:
- Request Object : DiscoverRequest
- Parameters
- search : search keyword
- categoryId: empty in this case
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : DiscoverChallenges
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns challenges list
For Searching Video

API Class : DiscoverInteractor

Method : getSearchedVideoList()

Returns the list of suggested challenges list based on queried keyword.

API Request:
- Request Object : DiscoverRequest
- Parameters
- search : search keyword
- categoryId: empty in this case
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : AllVideoInfo
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns video list
For Hashtag Details

API Class : DiscoverInteractor

Method : getHashtagDetails()

It returns the hashtag details and list of videos

API Request:
- Request Object : HashtagParams
- Parameters
- hashtagName : hashtag keyword
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : HashtagDetailInfo
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns hashtag details
API Class : DiscoverInteractor

Method : getHashtagVideo()

It returns list of videos tagged with particular hashtag

API Request:
- Request Object : HashtagParams
- Parameters
- hashtagName : hashtag keyword
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : HomeFeed
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- Message: It is a simple string message
- Page : it return page
- Total : it return total page
- PerPage : it return current page
- ListVideo : it return list of video
For Challenges Details

API Class : DiscoverInteractor

Method : getChallengesDetails()

It returns the challenges details and list of videos

API Request:
- Request Object : ChallengeDetailParams
- Parameters
- hashtagId : Challenges/hashtag id
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : ChallengeDetailList
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns Challenge details and list of videos
For Leader Board Details

API Class : DiscoverInteractor

Method : getChallengeLeaderBoardDetails()

It returns the leader board details

API Request:
- Request Object : LeaderboardParams
- Parameters
- hashtagId : Challenges/hashtag id
- limit: How many videos you want in a single response
- offset: it's the current page/offset
API Response:
- Response Object : LeaderBoardList
- Message: It is a simple string message
- StatusCode : It returns API status code (like 200,201,500,401)
- Success: It returns boolean value, (true/false)
- data : it returns LeaderBoard details