api

I have been playing around for half an hour now and also only get subscriptions for the current user :( The target.id param seems to be always causing an error and therefor going against how it's documented even though it is returned in the resultset.

You have 4 authentication options when using Postman to authenticate with the API

1. Session Key (local account username and password)
2. Bearer token using SDK Key
3. Access Token using pre-shared key (Dev Tools API apps)
4. OAuth Grant Flow (Community SSO)

Option #1 is the easiest/best option, and what I use most commonly. This means you would login with an account created locally on the community (not using SSO). In the latest version of Aurora (24.08), you can create such as user through Admin > Users > Manage Users.

Setting up Postman

1. Create a new collection
2. Create a new Environment to use with this collection (to hold variables).
   
   • sessionKey (secret) - leave blank
   • hostname (default) - set to your communities hostname (URL without https://)
   • username (default) - set to user created in community admin (or your username if local user)
   • password (secret) - the users community password
   • tapestry (default) - set to t5 (except for some special circumstances)
   • sessionStartTime (default) - leave blank
   • sessionLastUsed (default) - leave blank
   • ht_username (default) - set if you need to login to the community with basic auth credentials (the browser login popup)
   • ht_password (secret) - set if you need to login to the community with basic auth credentials (the browser login popup)
3. In the collection pre-request script, add the pre-request script (included below)
4. Create a new request in your collection
   1. Set the path to be POST https://{{hostname}}/{{tapestry}}/s/api/2.1/graphql
   2. Update headers:
      Key: li-api-session-key
      Value: {{sessionKey}}
5. In the request body, add your GraphQL
6. Execute Query
7. Save your Query (and collection)

Collection Pre-Request Script

var sessionKey = pm.environment.get("sessionKey");
var hostname = pm.environment.get("hostname");
var tapesty = pm.environment.get("tapestry");
var ht_username = pm.environment.get("ht_username");
var ht_password = pm.environment.get("ht_password")
var username = pm.environment.get("username");
var password = pm.environment.get("password");
var sessionStartTime = pm.environment.get("sessionStartTime","");
var sessionLastUsed = pm.environment.get("sessionLastUsed","");

const thirtyMinsAgo = Date.now() - (1000 * 60 * 30);
const twoHoursAgo = Date.now() - (1000 * 60 * 60 * 2);

if (sessionLastUsed == "" || sessionStartTime == "" || sessionLastUsed < thirtyMinsAgo || sessionStartTime < twoHoursAgo || sessionKey == "") {
    console.log("authenticating");
    authenticate();
} else {
    pm.environment.set("sessionLastUsed", Date.now());
}

function authenticate(){
    
    const request = {
        url: `https://${hostname}/${tapesty}/s/restapi/vc/authentication/sessions/login?user.login=${username}&user.password=${password}&restapi.response_format=json`,
        method: 'POST',
        header: {
            'Authorization': 'Basic '+btoa(`${ht_username}:${ht_password}`)
        },
    };
    pm.sendRequest(request, function (err, response) {
        if (err) {
            console.error(err);
            pm.execution.skipRequest();
            return;
        }
        const data = response.json();
        if (typeof (data.response.error) !== 'undefined' && typeof (data.response.error.message) !== 'undefined') {
            console.error(data.response.error.message);
            pm.execution.skipRequest();
            throw new Error("Authentication failed (see console)");
        } else {
            console.log("key", data.response.value.$)
            pm.environment.set("sessionKey", data.response.value.$);
            pm.environment.set("sessionStartTime", Date.now());
            pm.environment.set("sessionLastUsed", Date.now());
        }
    });
}

Optional Post-Response script

if (pm.response.code == 401){
    console.warn("Got unauthenticated response. Clearing variables.");
    pm.environment.set("sessionKey","");
    pm.environment.set("sessionLastUsed","");
    pm.environment.set("sessionStartTime","");
}

yogeshdixitChange the package name to "@customer/catfact-endpoint". If it still doesn’t work then request the Khoros support team to restart the community.

Hi Akenefick 

You might have better luck if you use the Community API v2 /search endpoint with a LiQL query that includes a date range in the WHERE clause. I'm not an engineer, but I was able to get what I think are correct responses on my QA site. 

For Total Posts by Board per defined time period, I tried the following query to the messages collection. Note that I included "(depth=0)" in the WHERE clause. That filters results to topics only. Remove it if you want both topics and replies in the response. Also, be sure to look at the note about using date ranges in LiQL queries when using the post_time field as a constraint. 

select count(*) from messages where board.id = 'suzieForum1' AND depth=0 AND post_time > 2018-10-07T10:04:30-08:00 AND post_time < 2021-07-19T10:04:30-08:00 

For Top Solution Authors by Board per defined time period, I tried the following. I took "Top" to be 'most kudoed' so that is how I ordered the results. Also, I only returned messages that had 1 or more kudos with "kudos.sum(weight) > 0".  I think you'd want to do something like that so that your response is lighter?

select author, subject, view_href, kudos.sum(weight) from messages where board.id = 'suzieForum1' AND kudos.sum(weight) > 0 AND is_solution = true AND post_time > 2013-10-07T10:04:30-08:00 AND post_time < 2021-07-19T10:18:30-08:00 order by kudos.sum(weight) DESC LIMIT 5 

I'm not sure how to get Total Members accessing the Board per defined time period. The boards collection has a views field, but I don't think that's unique views, and I don't know of a way to return whether views are by actual community members vs anonymous users. Perhaps someone in Services or Support has done something like this ChadB AdamN TysonN MattV ? Or maybe some of our other Titans Claudius jeffshurtliff allensmith81 ? Hopefully one of these folks can also verify whether my example queries are performant or not 😀.

Cheers!

There are no specific issues with using vanilla javascript to call endpoints.

Using LITHIUM.jQuery is recommended if you intended to use jQuery.

Also, using liaAddScript is recommended if you need the code to be executed near the bottom of the page after OOB javascript has executed (It may also do some minification/obfuscation). 

If none of those situations apply or are of concern, feel free to use plain JS in <script> tags. I would just encourage you to be mindful of code organization so the JS makes sense where it is placed, isn't repeated by multiple component includes, etc....

coreNode.permissions.hasPermission context object probably is the closest you can get. But it's rather limited as you can only check for the current user AND current node. E.g. you cannot use it easily in a navigation component to show/hide elements without reading permissions.

I'm wondering what you are trying to build though that wouldn't work with Khoros built-in permissioning? The API is quite good at hiding stuff where the current user doesn't have read permissions. Isn't that sufficient for your use case?