Forum Discussion

BHall's avatar
BHall
Leader
8 years ago

TKB article data - helpfulness rating and last updated - how to get it?

Has anyone had success using the API to get a couple key pieces of TKB data - helpfulness rating and last updated date, by article?

 

I know the data is somewhere, just curious on how to use the API to get it, since these two metrics do not seem to be part of LSI or advanced metrics.

 

-Brien

 

11 Replies

Sort By
  • TariqHussain's avatar
    TariqHussain
    Boss
    8 years ago

    BHall-

     

    Here is an API call to get the last updated date of any TKB article.

    SELECT current_revision.last_edit_time from messages where id = 'tkb_id'

    For the helpfulness of any TKB article, let me know if below API helps.

     http://community.lithium.com/community-name/restapi/vc / messages / id / [id]  / reviews / helpfulness

    Here is the documentation.

    https://community.lithium.com/t5/Developer-Documentation/bd-p/dev-doc-portal?section=commv1&leaf-id=Message.reviews#Message.reviews.rating

     

    Give kudos if you find my posts helpful or mark solution if it answers your query

    Tariq

  • BHall's avatar
    BHall
    Leader
    8 years ago

    Thanks TariqHussain!

     

    The first API call makes sense.

     

    for the second url, what am I supposed to be replacing? Obviously [id], but should it be "community.lithium.com" or "community.MYCOMMUNITY.com"?  Is "community-name" the actual name or something else?

     

     

    -Brien

     

  • TariqHussain's avatar
    TariqHussain
    Boss
    8 years ago

    BHall- It should be the base URL of your community e.g (community.MYCOMMUNITY.com).

     

    Give kudos if you find my posts helpful or mark solution if it answers your query

    Tariq

  • darrenSP's avatar
    darrenSP
    Mentor
    8 years ago

    Any ideas why helpfulness call gives me permission denied response?

  • irach15's avatar
    irach15
    Maven
    8 years ago

    same here,

    permissions denied and I'm an Admin :-(

  • irach15's avatar
    irach15
    Maven
    8 years ago

    TariqHussain,

    when I logged-in as admin and run url:

    ../restapi/vc/messages/id/[id]/reviews/helpfulness --> permissions denied

    ../restapi/vc/messages/id/[id]/reviews/rating --> permissions denied

    <response status="error">
<error code="303">
<message>Permission Denied</message>
</error>
</response>

    Should it just show the data?

     

    I have no problem seeing data running

    ../restapi/vc/messages/id/[id]

    and response in xml:

    <response status="success">...

     

    Giving up on that,

    I've coded in v2 ;-), something like

    <#assign articleHelpfulStats = rest(apiVersion,"/search?q=" + "SELECT * FROM tkb_helpfulness_ratings WHERE message.id = '${articleId}'"?url) />
            <#if articleHelpfulStats.data.items ?? >
                <#list articleHelpfulStats.data.items as articleHelpful >
                    <#if articleHelpful.value?c='true'>
                        was helpful
                    </#if>
                
                </#list>
            </#if>

     

  • TariqHussain's avatar
    TariqHussain
    Boss
    8 years ago

    irach15- If you want to see the response, you can use restd which will print the response as text. 

     

     

    <#assign articleHelpfulStats = restd(apiVersion,"/search?q=" + "SELECT * FROM tkb_helpfulness_ratings WHERE message.id = '${articleId}'"?url) />

${articleHelpfulStats}