Smart Tribune API

Smart Tribune’s REST API provides programmatic access to read and write Smart Tribune Datas, which lets third-party tools interact with our service. The API identifies users using OAuth, follows conventions for URLs, and returns responses in JSON format.

All calls to the API must be prepended with https://api.smart-tribune.com/v1/

Errors are reported with standard HTML error codes, and results are paginated.

All calls related to post/update/delete actions on the platforms are going to send mails like they do on the web application

We’re require applications to authenticate all of their requests with OAuth 1.0. This visibility allows us to prevent abusive behavior, and it alsos help us to further understand how categories of applications are using the API.


Find us on github



Informations

Our API supports OAuth method to make authenticated API requests:

Relevant URLs:

Summary

  1. Getting an access token
    Using the normal OAuth interaction, generate and store an access token/secret in your session/DB.
  2. Generating special URL
    You will then use this access token/secret to generate an authenticated OAuth call

The number of requests per account is limited depend of your plan and user role.

Role API call quota (per month)
User 2500
Reporter 5000
Moderator 5000
Organizator 10000
Administrator 20000

Our public PHP class will help you integrate and use our API with a few lines of code.
You can easily perform actions using method + simple verb such as get, create, update, delete ...

Download

PHP5.x - [API v1] Smart Tribune PHP Wrapper

Usage

Example n°1 : Get feedbacks from a specified platform
<?php
    require(path/to/REST-API-publicClass);

    $apiKey = 'Your_Api_Key';
    $apiSecret = 'Your_Api_Secret';
    $st = new SmartTribune($apiKey,$apiSecret);

    $params =array(
        platform_id => XXX,
    );
    $reponse = $st->feedbacks($params); //OR $reponse = $st->feedbacks_get($params);
?>
Example n°2 : Post a new feedback on a platform
<?php
  require(path/to/REST-API-publicClass);

  $apiKey = 'Your_Api_Key';
  $apiSecret = 'Your_Api_Secret';
  $st = new SmartTribune($apiKey,$apiSecret);

  $params =array(
      platform_id => XXX,
      category_id => XXX,
      title =>  'title of the feedback',
      body => 'Full description of the feedback'
  );
  $reponse = $st->feedbacks_create($params);
?>

In order to use Smart Tribune API, you need a Smart Tribune account (user/client) and an API key & API secret.
Currently, the API usage requires prior authorization. The API key requests are reviewed by our team.

To request an API key, please send your request including following details via our contact form.
Required information :

  • Smart Tribune Username
  • Your Email address (the one linked to your Smart Tribune account)
  • Website Url
  • Describe the intended use of your API key



Methods

Platforms

Implementation Notes

Get Smart Tribune platform(s)


Response Classes

Return JSON root object :
{ platformObject }
Name Data Type Description
platformObject
id
integer Id of the platform
platform_name
string Name of the platform
platform_url
integer Url of
online
boolean Whether platform is online or not
logo
string Platform logo url (90x90)
is_private
boolean Whether platform is private or public
feedback_count
integer Count of feedbacks for the platform
employee_count
integer Count of employees for the platform
categories
Optional
object Available categories for the platform See @categoryObject
most_recent_activity
Optional
string Most recent action performed
vote_count
Optional
integer Count of votes
comment_count
Optional
integer Count of comments
status
Optional
boolean Whether platform is active or not
created_date
Optional
integer Creation date of the platform
most_recent_date
Optional
datetime Most recent action date
account_id
Optional
integer Account id which owns the platform
small_logo
Optional
string Platform logo url (45x45)
user_count
Optional
integer Count of active users
getmood
Optional
string Whether mood of the users is enable or not
anonymous_vote
Optional
boolean Whether anonymous vote is allowed or not
report_abuse
Optional
boolean Whether user can report abuse or not
url_filter
Optional
boolean Whether links in content are allowed or not
search_engine
Optional
boolean Whether platform is indexed in search engine or not
ga_code
Optional
string Google analytics UA code
domain_alias
Optional
string Domain alias

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
optional
integer Id of the platform
Either id or platform_name or platform_domain or account_id must be supplied.
platform_name
optional
string Name of the platform
Either id or platform_name or platform_domain or account_id must be supplied.
platform_domain
optional
string Domain of the platform.
Either id or platform_name or platform_domain or account_id must be supplied.
account_id
optional
integer Unique account Id.
Either id or platform_name or platform_domain or account_id must be supplied.

Feedbacks

Implementation Notes

Get Smart Tribune discussion(s)


Response Classes

Return JSON root object :
{ 'results': feedbackObject }
Name Data Type Description
feedbackObject
id
integer Id of the feedback
feedback_url
string Url of the feedback page
state
string State value of the feedback if exist
platform_id
integer Id of the platform
type
string Type oif the element
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed
title
string Title of the feedback
author
string Author informations See @authorObject
custom_badge
string Custom badge
url
string API endpoint to feedback object
has_best_answer
boolean Whether the feedback has best answer
has_official_answer
boolean Whether the feedback has official answer
promoted
boolean Whether the feedback is promoted
content
string Body of the feedbackm
category
string Category title
slug
string Slug for the current feedback
following
string whether the feedback is followed by the user who is authenticated for the current API call
votes_count
integer Votes count for the current feedback
common_votes_count
integer Votes count for the whole discussion (including comments/answers)
follower_count
integer Followers count
reply_count
integer Comments and answers count
replies_url
string Api endpoint to feedback
attachments
Optional
array Attachment(s) of the feedback
themes
Optional
string Theme(s) of the feedback
mood
Optional
string Instant mood of the feedback
average_mood
Optional
string Average mood of the whole discussion
survey
Optional
string Survey attached to feedback See @surveyObject
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
custom_badge
string Custom badge of the author
surveyObject
survey_id
integer Id of the survey
survey_title
integer Title of the survey
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
optional
integer Unique feedback Id.
Either id or platform_id or account_id or user_id must be supplied.
platform_id
optional
integer Unique platform Id.
Either id or platform_id or account_id or user_id must be supplied.
account_id
optional
integer Unique account Id.
Either id or platform_id or account_id or user_id must be supplied.
user_id
optional
integer Unique user Id.
Either id or platform_id or account_id or user_id must be supplied.
category_id
optional
integer Category id (separated by coma if multiple)
theme_id
optional
integer Theme id (separated by coma if multiple)
state_id
optional
integer State id (separated by coma if multiple)

Implementation Notes

Create Smart Tribune discussion


Response Classes

Return JSON root object :
{ feedbackObject }
Name Data Type Description
feedbackObject
id
integer Id of the feedback
feedback_url
string Url of the feedback page
state
string State value of the feedback if exist
platform_id
integer Id of the platform
type
string Type oif the element
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed
title
string Title of the feedback
author
string Author informations See @authorObject
custom_badge
string Custom badge
url
string API endpoint to feedback object
has_best_answer
boolean Whether the feedback has best answer
has_official_answer
boolean Whether the feedback has official answer
promoted
boolean Whether the feedback is promoted
content
string Body of the feedbackm
category
string Category title
slug
string Slug for the current feedback
following
string whether the feedback is followed by the user who is authenticated for the current API call
votes_count
integer Votes count for the current feedback
common_votes_count
integer Votes count for the whole discussion (including comments/answers)
follower_count
integer Followers count
reply_count
integer Comments and answers count
replies_url
string Api endpoint to feedback
attachments
Optional
array Attachment(s) of the feedback
themes
Optional
string Theme(s) of the feedback
mood
Optional
string Instant mood of the feedback
average_mood
Optional
string Average mood of the whole discussion
survey
Optional
string Survey attached to feedback See @surveyObject
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
custom_badge
string Custom badge of the author
surveyObject
survey_id
integer Id of the survey
survey_title
integer Title of the survey
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Platform id.
category_id
required
integer Category id
theme_id
optional
integer Theme id (separated by coma if multiple)
state_id
optional
integer State id
title
required
string Title of the discussion
body
optional
string Body of the discuss
status
optional
string Body of the discuss
mood_id
optional
integer Id of the mood (1|Disaffected, 2|Frustrated, 3|Neutral, 4|Satisfied, 5|Delighted)
survey_id
optional
integer Id of the survey to be attached to the discussion

Implementation Notes

Update Smart Tribune discussion


Response Classes

Return JSON root object :
{ feedbackObject }
Name Data Type Description
feedbackObject
id
integer Id of the feedback
feedback_url
string Url of the feedback page
state
string State value of the feedback if exist
platform_id
integer Id of the platform
type
string Type oif the element
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed
title
string Title of the feedback
author
string Author informations See @authorObject
custom_badge
string Custom badge
url
string API endpoint to feedback object
has_best_answer
boolean Whether the feedback has best answer
has_official_answer
boolean Whether the feedback has official answer
promoted
boolean Whether the feedback is promoted
content
string Body of the feedbackm
category
string Category title
slug
string Slug for the current feedback
following
string whether the feedback is followed by the user who is authenticated for the current API call
votes_count
integer Votes count for the current feedback
common_votes_count
integer Votes count for the whole discussion (including comments/answers)
follower_count
integer Followers count
reply_count
integer Comments and answers count
replies_url
string Api endpoint to feedback
attachments
Optional
array Attachment(s) of the feedback
themes
Optional
string Theme(s) of the feedback
mood
Optional
string Instant mood of the feedback
average_mood
Optional
string Average mood of the whole discussion
survey
Optional
string Survey attached to feedback See @surveyObject
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
custom_badge
string Custom badge of the author
surveyObject
survey_id
integer Id of the survey
survey_title
integer Title of the survey
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique feedback Id
category_id
required
integer Category id
theme_id
optional
integer Theme id (separated by coma if multiple)
state_id
optional
integer State id
title
required
string Title of the discussion
body
optional
string Body of the discuss
status
optional
string Body of the discuss
mood_id
optional
integer Id of the mood (1|Disaffected, 2|Frustrated, 3|Neutral, 4|Satisfied, 5|Delighted)
survey_id
optional
integer Id of the survey to be attached to the discussion

Implementation Notes

Delete Smart Tribune discussion


Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique feedback Id

Comments

Implementation Notes

Get Smart Tribune comment(s)


Response Classes

Return JSON root object :
{ 'results': commentObject }
Name Data Type Description
commentObject
id
integer Id of the comment
feedback_id
integer Id of the parent feedback
platform_id
integer Id of the platform
type
string Type of the element
created_date
datetime Creation date of the comment
author
object Author informations See @authorObject
url
string API endpoint to comment object
content
string Body of the comment
votes_count
integer Votes count for the current comment
promoted
boolean Whether the comment is promoted
votes
boolean Whether current logged API user has voted or not
official
boolean Whether the comment has official status
reply_count
integer Answers count
replies_url
string Api endpoint to answers
attachments
Optional
array Attachment(s) of the comment
mood
Optional
string Instant mood of the feedback
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
optional
integer Unique feedback Id.
Either id or platform_id or account_id or user_id must be supplied.
platform_id
optional
integer Unique platform Id.
Either id or platform_id or account_id or user_id must be supplied.
parent_id
optional
integer Unique parent Id.
Either id or platform_id or account_id or user_id must be supplied.
user_id
optional
integer Unique user Id.
Either id or platform_id or account_id or user_id must be supplied.

Implementation Notes

Create Smart Tribune comment


Response Classes

Return JSON root object :
{ commentObject }
Name Data Type Description
commentObject
id
integer Id of the comment
feedback_id
integer Id of the parent feedback
platform_id
integer Id of the platform
type
string Type of the element
created_date
datetime Creation date of the comment
author
string Author informations See @authorObject
url
string API endpoint to comment object
content
string Body of the comment
votes_count
integer Votes count for the current comment
promoted
boolean Whether the comment is promoted
votes
boolean Whether current logged API user has voted or not
official
boolean Whether the comment has official status
reply_count
integer Answers count
replies_url
string Api endpoint to answers
attachments
Optional
array Attachment(s) of the comment
mood
Optional
string Instant mood of the feedback
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
parent_id
required
integer Unique parent feedback Id.
body
required
string Body of the comment
mood_id
optional
integer Id of the mood (1|Disaffected, 2|Frustrated, 3|Neutral, 4|Satisfied, 5|Delighted)

Implementation Notes

Create Smart Tribune comment


Response Classes

Return JSON root object :
{ commentObject }
Name Data Type Description
commentObject
id
integer Id of the comment
feedback_id
integer Id of the parent feedback
platform_id
integer Id of the platform
type
string Type of the element
created_date
datetime Creation date of the comment
author
string Author informations See @authorObject
url
string API endpoint to comment object
content
string Body of the comment
votes_count
integer Votes count for the current comment
promoted
boolean Whether the comment is promoted
votes
boolean Whether current logged API user has voted or not
official
boolean Whether the comment has official status
reply_count
integer Answers count
replies_url
string Api endpoint to answers
attachments
Optional
array Attachment(s) of the comment
mood
Optional
string Instant mood of the feedback
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique comment Id
body
required
string Body of the comment
mood_id
optional
integer Id of the mood (1|Disaffected, 2|Frustrated, 3|Neutral, 4|Satisfied, 5|Delighted)

Implementation Notes

Delete Smart Tribune comment


Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique comment Id

Categories

Implementation Notes

Get categories


Response Classes

Return JSON root object :
{ 'results': categoryObject }
Name Data Type Description
categoryObject
id
integer Id of the category
platform_id
integer Id of the platform
name
string Name of the category
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Unique platform Id.

Implementation Notes

Create new category


Response Classes

Return JSON root object :
{ categoryObject }
Name Data Type Description
categoryObject
id
integer Id of the category
platform_id
integer Id of the platform
name
string Name of the category
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Unique platform Id
name
required
string Name of the category
title
required
string Title of the category
description
optional
string Category description

Implementation Notes

Update an existing category


Response Classes

Return JSON root object :
{ categoryObject }
Name Data Type Description
categoryObject
id
integer Id of the category
platform_id
integer Id of the platform
name
string Name of the category
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique category Id
name
required
string Name of the category
title
required
string Title of the category
description
optional
string Category description

Implementation Notes

Delete an existing category


Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique category Id

States

Implementation Notes

Get states


Response Classes

Return JSON root object :
{ 'results': stateObject }
Name Data Type Description
stateObject
id
integer Id of the state
platform_id
integer Platform Id
name
string Name of the state
title
string Title of the state
description
string State description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id

POST /states/

Implementation Notes

Create new state


Response Classes

Return JSON root object :
{ stateObject }
Name Data Type Description
stateObject
id
integer Id of the state
platform_id
integer Unique platform Id
name
string Name of the state
title
string Title of the state
description
string State description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Unique platform Id
name
required
string Name of the state
title
required
string Title of the state
description
optional
string State description

Implementation Notes

Update an existing state


Response Classes

Return JSON root object :
{ stateObject }
Name Data Type Description
stateObject
id
integer Id of the state
platform_id
integer Unique platform Id
name
string Name of the state
title
string Title of the state
description
string State description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique state Id
name
required
string Name of the state
title
required
string Title of the state
description
optional
string State description

DELETE /states/id

Implementation Notes

Delete an existing state


Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique state Id

Themes

Implementation Notes

Get themes


Response Classes

Return JSON root object :
{ 'results': themeObject }
Name Data Type Description
themeObject
id
integer Id of the theme
platform_id
integer Platform Id
name
string Name of the theme
title
string Title of the theme
description
string Theme description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id

POST /themes/

Implementation Notes

Create new theme


Response Classes

Return JSON root object :
{ themeObject }
Name Data Type Description
themeObject
id
integer Id of the theme
platform_id
integer Platform Id
name
string Name of the theme
title
string Title of the theme
description
string Theme description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Unique platform Id
name
required
string Name of the theme
title
required
string Title of the theme
description
optional
string Theme description

Implementation Notes

Update existing theme


Response Classes

Return JSON root object :
{ themeObject }
Name Data Type Description
themeObject
id
integer Id of the theme
platform_id
integer Platform Id
name
string Name of the theme
title
string Title of the theme
description
string Theme description

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique theme Id
name
required
string Name of the theme
title
required
string Title of the theme
description
optional
string Theme description

DELETE /themes/id

Implementation Notes

Delete existing theme


Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique theme Id

Users

Implementation Notes

Get users


Response Classes

Return JSON root object :
{ 'results': userObject }
Name Data Type Description
userObject
created_date
datetime User creation date
user_url
string User profile url
user_id
integer Unique user id
user_name
string Username of the user
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string User API endpoint
feedbacks_count
integer Count of feedbacks submitted by the user
comments_count
integer Count of comments submitted by the user (include answers)
votes_count
integer Count of votes submitted by the user
is_sso_user
boolean Whether the user is an SSO user or not
badge
string Badge of the user
platform_id
Optional
integer Specified platform id
custom_badge
Optional
string Custom badge of the user

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
id
required
integer Unique user Id.
platform_id
optional
integer Unique platform Id.

Votes

Implementation Notes

Get votes


Response Classes

Return JSON root object :
{ 'results': voteObject }
Name Data Type Description
voteObject
vote_date
integer Date of the vote
voted_for
integer Element which receive the vote
entity_id
string Id of the element which receive the vote
author
object Author informations See @authorObject
url
string Url of the element which receive the vote
content
string
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
required
integer Unique platform Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.
feedback_id
required
integer Unique feedback Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.
comment_id
required
integer Unique comment Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.
user_id
optional
integer Unique user Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.

POST /votes/

Implementation Notes

Create votes


Response Classes

Return JSON root object :
{ voteObject }
Name Data Type Description
voteObject
vote_date
integer Date of the vote
voted_for
integer Element which receive the vote
entity_id
string Id of the element which receive the vote
author
object Author informations See @authorObject
url
string Url of the element which receive the vote
content
string
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
feedback_id
required
integer Unique feedback Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.
comment_id
required
integer Unique comment Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.
response_id
optional
integer Unique user Id.
Either platform_id or feedback_id or comment_id or account_id or user_id must be supplied.

Alerts

Implementation Notes

Get Smart Tribune alert(s) for the current logged user OR a sepcified user OR get subscribers for a specified feedbacks


Response Classes

Return JSON root object :
{ 'results': feedbackObject } or { 'results': userObject }
Name Data Type Description
feedbackObject
state
string State value of the feedback if exist
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed
employee
boolean Whether the feedback was created by an employee or not
certified
string Whether the feedback was created by an certified user or not
title
string Title of the feedback
platform_id
integer Id of the platform
author
string Author informations See @authorObject
url
string API endpoint to feedback object
has_best_answer
boolean Whether the feedback has best answer
has_official_answer
boolean Whether the feedback has official answer
has_top_position
boolean Whether the feedback is promoted
content
string Body of the feedbackm
category
string Category title
slug
string Slug for the current feedback
following
string whether the feedback is followed by the user who is authenticated for the current API call
votes_count
integer Votes count for the current feedback
common_votes_count
integer Votes count for the whole discussion (including comments/answers)
follower_count
integer Followers count
reply_count
integer Comments and answers count
replies_url
string Api endpoint to feedback
themes
Optional
string Theme(s) of the feedback
mood
Optional
string Instant mood of the feedback
average_mood
Optional
string Average mood of the whole discussion
survey
Optional
string Survey attached to feedback See @surveyObject
userObject
created_date
datetime User creation date
user_url
string User profile url
user_id
integer Unique user id
user_name
string Username of the user
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string User API endpoint
feedbacks_count
integer Count of feedbacks submitted by the user
comments_count
integer Count of comments submitted by the user (include answers)
votes_count
integer Count of votes submitted by the user
is_sso_user
boolean Whether the user is an SSO user or not
badge
string Badge of the user
platform_id
Optional
integer Specified platform id
custom_badge
Optional
string Custom badge of the user
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
certified
boolean is the author certified on specified platform
employee
boolean is the author employee on specified platform
canonical_name
string Author profile slug (/profile/[canonical_name]
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
user_id
optional
integer Unique user id. Get alerts from a specified user
feedback_id
optional
integer Unique feedback Id. Get subscribers to the alert of a specified feedback

Moods

Implementation Notes

Get moods


Response Classes

Return JSON root object :
{ 'results': moodObject }
Name Data Type Description
moodObject
id
integer Id of the mood
label
string Label of the mood
score
string Score of the mood

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description

Surveys

Implementation Notes

Get surveys


Response Classes

Return JSON root object :
{ 'results': surveyObject }
Name Data Type Description
surveyObject
id
integer Id of the survey
platform_id
integer Platform Id
title
string Title of the survey
survey_taken_count
integer Count of survey submissions
has_submitted
string Current user passed this survey

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id
status
optional
string Survey status (active/inactive)

Feedback Statistics

Implementation Notes

Get feedback statistics


Response Classes

Return JSON root object :
{ 'feedback_statistics': statisticsObject }
Name Data Type Description
statisticsObject
feedbacks_count
Optional
integer Count of feedbacks
comment_count
Optional
integer Count of comments
users_count
Optional
integer Count of users
votes_count
Optional
string Count of votes
average_feedback
Optional
datetime Average of feedbacks
average_comment
Optional
object Average of comments
average_vote
Optional
string Average of votes
answers_count
Optional
string Cpount of answers
average_answer
Optional
string Average of answers
subscriber_count
Optional
string Count of subscribers
surveys_count
Optional
string Count of surveys
surveys_average
Optional
string Average of surveys

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id.
Either platform_id or account_id or feedback_id must be supplied.
feedback_id
optional
integer Unique feedback Id.
Either platform_id or account_id or feedback_id must be supplied.
account_id
optional
integer Unique account Id.
Either platform_id or account_id or feedback_id must be supplied.

Comment statistics

Implementation Notes

Get comment statistics


Response Classes

Return JSON root object :
{ 'comment_statistics': statisticsObject }
Name Data Type Description
statisticsObject
feedbacks_count
Optional
integer Count of feedbacks
comment_count
Optional
integer Count of comments
users_count
Optional
integer Count of users
votes_count
Optional
string Count of votes
average_feedback
Optional
datetime Average of feedbacks
average_comment
Optional
object Average of comments
average_vote
Optional
string Average of votes
answers_count
Optional
string Cpount of answers
average_answer
Optional
string Average of answers
subscriber_count
Optional
string Count of subscribers

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id.
Either platform_id or account_id or feedback_id must be supplied.
feedback_id
optional
integer Unique feedback Id.
Either platform_id or account_id or feedback_id must be supplied.
account_id
optional
integer Unique account Id.
Either platform_id or account_id or feedback_id must be supplied.

Vote Statistics

Implementation Notes

Get vote statistics


Response Classes

Return JSON root object :
{ 'vote_statistics': statisticsObject }
Name Data Type Description
statisticsObject
feedbacks_count
Optional
integer Count of feedbacks
comment_count
Optional
integer Count of comments
users_count
Optional
integer Count of users
votes_count
Optional
string Count of votes
average_vote
Optional
string Average of votes
answers_count
Optional
string Cpount of answers
average_answer
Optional
string Average of answers

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
platform_id
optional
integer Unique platform Id.
Either platform_id or account_id or feedback_id must be supplied.
feedback_id
optional
integer Unique feedback Id.
Either platform_id or account_id or feedback_id must be supplied.
account_id
optional
integer Unique account Id.
Either platform_id or account_id or feedback_id must be supplied.

Search

Implementation Notes

Search feedback


Response Classes

Return JSON root object :
{ 'feedback': feedbackObject }
Name Data Type Description
feedbackObject
id
integer Id of the feedback
feedback_url
string Url of the feedback page
state
string State value of the feedback if exist
platform_id
integer Id of the platform
type
string Type oif the element
created_date
datetime Creation date of the feedback
status
string Status of the feedback (active/reported/spam/archive/inactive)
most_recent_date
datetime Most recent action date
most_recent_activity
datetime Most recent action performed
title
string Title of the feedback
author
string Author informations See @authorObject
custom_badge
string Custom badge
url
string API endpoint to feedback object
has_best_answer
boolean Whether the feedback has best answer
has_official_answer
boolean Whether the feedback has official answer
promoted
boolean Whether the feedback is promoted
content
string Body of the feedbackm
category
string Category title
slug
string Slug for the current feedback
following
string whether the feedback is followed by the user who is authenticated for the current API call
votes_count
integer Votes count for the current feedback
common_votes_count
integer Votes count for the whole discussion (including comments/answers)
follower_count
integer Followers count
reply_count
integer Comments and answers count
replies_url
string Api endpoint to feedback
attachments
Optional
array Attachment(s) of the feedback
themes
Optional
string Theme(s) of the feedback
mood
Optional
string Instant mood of the feedback
average_mood
Optional
string Average mood of the whole discussion
survey
Optional
string Survey attached to feedback See @surveyObject
video
Optional
string Video attached to feedback See @videoObject
authorObject
user_url
string Author profile url
user_id
integer Author user id
user_name
string Author username
small_avatar_url
string URL path to small size avatar image
medium_avatar_url
string URL path to medium size avatar image
avatar_url
string URL path to full size avatar image
url
string Author API endpoint
custom_badge
string Custom badge of the author
surveyObject
survey_id
integer Id of the survey
survey_title
integer Title of the survey
videoObject
source
string Source of the video
id
integer Id of the video

Response Errors

HTTP Status Code Reason
404 Not Found
500 Internal server error
503 Service unavailable

Path Parameters

Name Value Data Type Description
query
required
integer Search query
platform_id
required
integer Unique platform Id
theme
optional
integer Filter search query with themes
category
optional
integer Filter search query with category
status
optional
string Status of the element (active,inactive,reported,spam,archive)