Variables in Feeds

 

Overview

 

Jive supports a number of variables in feed URLs, allowing greater flexibility and control over what changes can be learned without having to log in to the community.

This article provides information about the different variables Jive offers for use in feed URLs.

---

 

Information

 

Available variables

 

You can use the following variables while defining feed URLs:

• tag_name: The tag applied to the blog post. In the user interface, tags are listed at the bottom of the post, or in the content.
• user_name: The user's login name.
• community_id: The community ID. You can find this number at the end of the URL after you click View Feeds in the All Content page. In the Admin Console, the ID number is shown at Spaces > Settings > Space Settings.
• document_id: A unique identifier for a document. You can find the ID at the end of the URL when you're viewing a document in the application.
• post_id: A unique identifier for a blog post.
• blog_name: A blog's name. For a user blog, this is typically the user's name.
• search_string: For feeds based on searches, this is the URL search parameter created when the user searches.

 

Examples

 

Here is an example with the typical full set of search parameters included. In this case, the search term is "macro".

 

q=macro&resultTypes=BLOG_POST&resultTypes=DOCUMENT&resultTypes=MESSAGE&resultTypes=COMMUNITY
    &peopleEnabled=true&dateRange=all&communityID=2000&numResults=15&rankBy=10001

 

The example search string includes the following parameters:

• resultTypes: The kinds of content to search.
• peopleEnabled: Whether to search people's profiles.
• dateRange: The date range when the content was added. Acceptable values are: yesterday, last7days, last30days, last90days, thisyear, and lastyear.
• communityID: The ID number for the space.
• numResults: The number of results to display.
• rankBy: How results should be sorted. Acceptable values are: rating, relevance, subject, likes, and date. For example, you can specify rankBy=rating.

 

Additional parameters

 

You can also include the following parameters in your feed URL:

• full: Whether to include the full content in the results. Include full=false as a parameter when you want to return just a summary in feed results.
• numItems: The number of results to return. For example, you could include numItems=25 returning 25 results. The default is 10.

In addition, if your community requires basic authentication (a user name and password), you might need to prepend the feed URL with the user name and password parameters. Here is an example:

https://<username>:<password>@<domain>/community/feeds/documents

If you do not want to enable basic authentication but still need to send a user name and password, you can use the following form (note that this is less secure):

https://<domain>/community/feeds/documents?username=<username>&password=<password>

Back to top