A Quick Example of rendering related links¶

The Parse.ly JavaScript API binding is available with the following script tag inserted anywhere in your webapp. Note that JavaScript Tracker automatically includes the API functions, so there is no need to include both.

<!-- Include Parse.ly JS API binding -->
<script src="http://static.parsely.com/api.js"></script>
<!-- Container for custom related article link bar -->
<ul id="related-articles"></ul>
<script>
(function($) {
    // (note: assumes jQuery exists, gets aliased as $)
    // first, fetch element to render links inside of
    var elm = $("#related-articles");
    // set API key that is used for requests
    PARSELY_CFG = {api_key: "##########"};
    // call Parse.ly API, assumes location.href is an
    // web page already indexed by Parse.ly
    PARSELY.Api.listRelated(location.href,
        function callback(data) {
            // callback happens when API returns
            $.each(data.items, function(i, item) {
                item = item.item;
                // iterate through each item, and append
                // a link for each using title and link URL
                elm.append([
                    "<li>",
                    "<a href='",
                        item.link,
                        "'>",
                        item.title,
                    "</a>",
                    "</li>"].join(""));
            });
        }
    );
})(jQuery);
</script>

This will generate a list of related links that looks something like this (note, this is a screen capture of an example):

Introspect API for documentation¶

The JavaScript API is self-documenting. The API includes a documentation component that can output to a standard console.log JavaScript console (available in Chrome and Firefox with Firebug) by simply calling PARSELY.Api.introspect(). It will show all valid API URLs and all valid arguments, as well as documentation for all of the methods. For convenience, a listing of all available API methods is reproduced here. You call these off the PARSELY.Api object.

• introspect: prints out API documentation to console.log
• listProfiles: lists all profiles in system
• getProfile: gets profile for a particular profileId
• listVisits: gets all visits for specified profileId
• listRelated: lists related content for given page url
• listTopics: lists topics related to given article url
• listRecommended: personalized recommendations for user with given profileId
• queryItems: arbitrary query for items (e.g. all articles with keyword “Obama”)