API v2 use cases
Comments
-
I see Q&A listed a couple of times in this thread but just do add what Automic asked me:
Myself and the team been working with REST Webservices using the APIv2 and noticed that there doesn’t appear to be the options to return information about Q&A discussion type, such as if they are Q&A or if they been answered or not.
Can I make a request for an “enhancement request” on the GET /Discussion APIv2 for a future release to provide information on Q&A0 -
Q&A endpoint(s) is included for the 2.6 release.
0 -
Querying a post for reactions SINCE a given time. Qualtrics is looking to be able to pull which discussions have accumulated the most positive reactions within them as part of an analytic (they are using the query) to determine which posts content is the most helpful to their clients.
1 -
Tomodomo uses our API quite a bit when they do custom work for our customers. They've passed along this feedback:
I noticed the expanded API v2 Discussions endpoint (/api/v2/discussions?expand=true) returns the Category ID, but not the category name.
This means that if we're building, say, a discussion table/list with APIv2, and want to display the post's category, we would need to make an API request for every category ID to get their names, or request all the categories and write extra code to map them to each post.
It would be awesome if the Expanded (?expand=true) version of the endpoint added a "category" object, in the same way it adds an "insertUser" object in addition to the "insertUserId". Could just include the category name and URL, so you could easily display the category name and link it to the actual category.
0 -
Qualtrics was wondering if instead of simply being able to query post score via API (which apparently is going to be in 2.6) if they would also be able to pull which individual reactions get pulled from a discussion.
0 -
@BrendanParm said:
Qualtrics was wondering if instead of simply being able to query post score via API (which apparently is going to be in 2.6) if they would also be able to pull which individual reactions get pulled from a discussion.I expect this will be possible by 2.7 or 2.8.
0 -
-
0
-
For ticket deflection it would be nice to have a way to measure reactions on accepted answers. Or a way to get pageviews on accepted answers.
3 -
From Valify :
API operations needed for Tag Management:
- list of all tags returning their id, name, slug, and # posts against each
- create new tag with name Y and slug Z
- update the name and/or slug of tag X
- delete tag X
0 -
@Adrian said:
Or a way to get pageviews on accepted answers.That's not an API request. We don't track pageviews that granularly, so there's no way to expose that. That's perhaps an Analytics request. I'm also unclear if you're asking for pageviews of the discussion AFTER the comment is accepted, or pageviews that linked directly to the comment.
0 -
@Adrian said:
For ticket deflection it would be nice to have a way to measure reactions on accepted answers.Are you just asking for a full Reactions breakdown to be available over the API for posts in general, or something more specific than that? We plan to expose full Reactions for either 2.7 or 2.8 - it's a requirement for Aurora.
0 -
@linc I’ve opened an enhancement request for analytics actually earlier today. What I was trying to see or understand was how we can expose how many pageviews best answers get. I figured adding reports to the analytics dashboard is less likely to happen then getting this exposed via analytics API.
The second part is an ability to get a way to know the positive or negative reactions to those best answers at a more granular level. I recognize the second one is hard, and certainly if we ever get a way to measure “was this answer helpful”, it would negate needing this.
This request or idea came from a couple of conversations from customers trying to get hard numbers around how Q & A is impacting ticket deflection. I’m open to ideas, but these two data points would help and I can see how it adds value for our customers to prove community ROI.
0 -
@ValR Tagging support in API v2 is slated for 2.7. See here: https://github.com/vanilla/roadmap/projects/2 (2.7 column; scroll to API v2 card)
0 -
Current API v2 requirements in 2.7:
- Multisite
- Ignore
- Signatures
- Authenticate
- User SSO / SmartID lookup
- Tagging
- Online
The 2.7 release will therefore complete our API v1 parity, which means we'll be able to hide the Simple API addon from future customers after that release.
2 -
@Linc said:
@Adrian said:
Or a way to get pageviews on accepted answers.That's not an API request. We don't track pageviews that granularly, so there's no way to expose that. That's perhaps an Analytics request. I'm also unclear if you're asking for pageviews of the discussion AFTER the comment is accepted, or pageviews that linked directly to the comment.
How do we track, discussions and questions with the most views? couldn't we use those view counts? Follow-up question, what's the difference between the view counter and a pageview?
0 -
@JoeF said:
How do we track, discussions and questions with the most views? couldn't we use those view counts? Follow-up question, what's the difference between the view counter and a pageview?Pretty sure you've misinterpreted my answer to Adrian, because it has nothing to do with your current questions. "Accepted answer" views imply only counting views since an answer was accepted (a state change) which we cannot do over the API. We have 1 tally per discussion.
For your question, yes, that's view counts. There isn't a difference.
0 -
Sending moderation notes over the API to populate external systems with this info.
i.e Walkme wanted a way to create notes on users they could pass to Salesforce.
1 -
Datorama is asking this:
One other question - will we be able to get URL's through the API? So that we can see a User ID against the URL of the Page (discussion, for example) he/she was looking at?
Maybe a side note, but @Adrian might know if this is possible via Google Analytics, at least for now?
0 -
@shaunamcclemens technically Google Analytics could be used, but they must be aare of PII sharing restrictions. Here is more info https://developers.google.com/analytics/solutions/crm-integration#user_id
0 -
@JoeF Yes, they don't have the same issue with PII. I guess it depends if @shaunamcclemens customer is using it/ has access --- sometimes those tools are siloed
0 -
Ability to add an idea via API and give it a different status rather than the default. This appears to not be documented but I asked Cireson if they thought it would be useful because I knew they were trying to integrate with Aha for ideation.
It would be useful yes, especially for internal ideas that we want to make public before acting on them.
Primarily though, I’ve setup an azure function that is triggers by a webhook out of aha when an idea or feature in aha is updated. It looks for the corresponding discussion in vanilla and then updates the score to aha and the status and message from aha into vanilla.
It works except for this issue you just resolved.
One issue we have though is there is no way to “filter” a set of discussions by idea status, as we would like to be able to see when an idea changes status or the score is updated.
A webhook on changes out of vanilla would be amazing also. ?
I am unsure if the filtering is something that is possible currently and he's just unaware or if that's another legitimate API request.
0 -
EA as well as a handful of corps are interested in 'delete method' as it pertains to deleting users.
It looks like you can define which method you want to use to delete a user via APIv1 (wipe, keep, delete, I believe), but not with APIv2.
They are using to automate their users being deleted from communities when being deleted from EA mainsite, and other customers have mentioned it within the GDPR context.
1 -
@shaunamcclemens said:
We’d like to be able to read custom user fields (from the profile extender plugin)This is also something Tomodomo requested.
Specifically -
The ability to edit profile extender fields via APIv2. I don’t mean editing what the fields are, but editing their contents for a specific user.
0 -
@ValR said:
Capital One, Plex, On Shape and many more are asking for a way to pull users of a specific role over API. The very minimum would be role-types, but at the end of the day, most will want this by individual role-name as well.The reason they need that granularity is that many of them are looking to feed this information to their reporting systems to show the success of their moderators, and admin, or show the success of particular programs that center around community. For example, Plex needs to keep track of their "Ninjas" these are volunteer beta testers, and they don't fit under "member" nor do they fit under "moderator" they have no role-type.
I'm getting this request from ESLGaming to be able to audit their admins and mods.
0 -
Capital One is looking for an API endpoint to pull a list of contributors - there is a leaderboard in Analytics that can be called over API for the top 10 within a given time-frame, but they're looking for something they can use that could be user-facing.
0 -
Capital One also asking for ability to make a call to see how many "likes" a specific user has given out, rather than just the "likes" they've received from others. In their view this a metric that can show a certain level of engagement on behalf of the user.
1 -
@shaunamcclemens said:
@ValR said:
Capital One, Plex, On Shape and many more are asking for a way to pull users of a specific role over API. The very minimum would be role-types, but at the end of the day, most will want this by individual role-name as well.The reason they need that granularity is that many of them are looking to feed this information to their reporting systems to show the success of their moderators, and admin, or show the success of particular programs that center around community. For example, Plex needs to keep track of their "Ninjas" these are volunteer beta testers, and they don't fit under "member" nor do they fit under "moderator" they have no role-type.
I'm getting this request from ESLGaming to be able to audit their admins and mods.
Hearing Journey's recently asked for this - it also seems to come up a lot in Support communities
0
