API v1 Reference Guide

You are here:

Product Object

Item Type Description
product_id int The products unique ID.
title str The products title.
url str The products public url.
logo str The product logo. Empty if no product is set.
version str The current product version. Empty if the Talk module is not used.
visibility str Either “public” or “private”.
created_date int The UNIX timestamp the product was created. (GMT)
total_members int The total number of product members with an active request.st account.
signup_status str Either “on” if signup is enabled else “off”.
login_status str Either “on” if login is enabled else “off”.
listen bool | obj The listen object if enabled else false.
talk bool | obj The talk object if enabled else false.
launch bool | obj The launch object if enabled else false.
categories array Array of category objects used for this product.
statuses obj The list of request statuses used for this product.

Category Object

Item Type Description
term_id int The category term ID.
title str The category title.
description str The category description.
bg_color str The background color set for for this category.
text_color str The text color set for this category.

 

Listen Module

Item Type Description
product_id int The products unique ID.
title str The module title.
url str The modules public url.
items array An array of requests that matches your filter criteria (if used) else requests ordered by publishing date.
item_count int Number of requests in the items array.
current_page int The current page number in pagination. Defaults to 1.
more_items bool Indicates if there are more requests to show for pagination.
total_items int The total number of requests that exists.
max_page int The maximum number of pages available for pagination.

Request Object

Item Type Description
request_id int The requests unique ID.
title str The request title.
url str The request public url.
created_date int The UNIX timestamp the request was created. (GMT)
description str The request description or the feature description (if set).
original_description str If a Feature description is set, the original description will be available here.
visibility str The visibility of the request. This can be “visible” or “private”.
author str The request authors name.
author_avatar str The request authors avatar image element.
vote_status str The status of voting for this request. Either “open” or “closed”.
vote_count int The total number of votes cast for this request.
vote_result int The request voting result. Note that this can be a positive or negative integer.
comment_status str The status of comments for this request. Either “open” or “closed”.
comment_count int The total number of comments cast for this request.
comments array An array of comment objects if requested.
status str The status ID of the request.
category obj | int The category object if one is set else zero.

Comment Object

Item Type Description
comment_id int The comments unique ID.
internal int Indicates if the comment is internal (1) or public (0).
created_date int The UNIX timestamp when the comment was published. (GMT)
author str The comment authors name.
author_email str The comment authors email.
comment str The comment body.
author_role int The comment authors role ID. Product member (1) or Product Owner (2).
is_customer int Indicates if the comment author is a customer at request.st (1) or not (0).
is_product_admin int Indicates if the comment author is a product member for this product (1) or not (0).

 

Talk Module

Item Type Description
product_id int The products unique ID.
title str The module title.
url str The modules public url.
items array An array of updates that belongs to this Talk module.
item_count int Number of updates in the items array.
current_page int The current page number in pagination. Defaults to 1.
more_items bool Indicates if there are more updates to show for pagination.
total_items int The total number of updates that exists.
max_page int The maximum number of pages available for pagination.

Update Object

Item Type Description
release_id int The updates unique ID.
title str The update title.
url str The talk module url.
created_date int The UNIX timestamp the update was created. (GMT)
description str The update description.
visibility str The visibility of the update. This can be “visible”, “private” or “scheduled”.
author str The update authors name.
author_avatar str The update authors avatar image element.
type str The update type. Either “release” or “announcement”.
code str Release codename. Not used by updates of type “announcements”.
version str Version number. Not used by updates of type “announcements”.
requests array An array of request objects that are associated with this update. Not used by updates of type “announcements”.

 

Launch Module

Item Type Description
product_id int The products unique ID.
title str The module title.
url str The modules public url.
items array An array of campaigns that matches your filter criteria (if used) else campaigns ordered by publishing date.
item_count int Number of campaigns in the items array.
current_page int The current page number in pagination. Defaults to 1.
more_items bool Indicates if there are more campaigns to show for pagination.
total_items int The total number of campaigns that exists.
max_page int The maximum number of pages available for pagination.

Campaign Object

Item Type Description
campaign_id int The campaigns unique ID.
title str The campaign title.
url str The campaign url.
created_date int The UNIX timestamp the campaign was created. (GMT)
description str The campaign description.
visibility str The visibility of the request. This can be “visible”, “private” or “scheduled”.
author str The request authors name.
author_avatar str The request authors avatar image element.
engagement_total int The campaign engagement.
view_count int The total number of unique views the campaign has.
schedule obj The campaigns current schedule setup.
leaderboard array An array of leaderboard objects if the leaderboard is used and requested in the query.

Campaign Schedule Object

Item Type Description
status str The current schedule status. Either “active”, “pending” when campaign is pending to start, “ended” when campaign has ended.
start int The UNIX timestamp when the campaign starts/started based on the companies set timezone.
start_gmt int The UNIX timestamp when the campaign starts/started (GMT).
start_js str The start date and time for display in JavaScript.
start_date str The start date formatted based on the company setup.
start_time str The start time formatted based on the company setup.
end int The UNIX timestamp when the campaign ends/ended based on the companies set timezone.
end_gmt int The UNIX timestamp when the campaign ends/ended (GMT).
end_js str The end date and time for display in JavaScript.
end_date str The end date formatted based on the company setup.
end_time str The end time formatted based on the company setup.
until_since int The number of second to the start time (if campaign is pending to start), the number of seconds till the campaign ends (if the campaign has started and an end time is set) or the number of seconds since the campaign ended (if the campaign has an end date). Else zero.

Leaderboard Object

Item Type Description
row_id int The leaderboard row ID.
public_id str The users public ID which is used to identify them when making a referral.
active bool Indicates if the user is marked as “active” (1) or not (0). Used when campaign signups require verification.
public_name str The publicly shown “name” for each user based on their email address.
joined_date int The UNIX timestamp when the user signed up for this campaign. (GMT)
referrals int The number of referrals made by this user.
last_referral int | bool The UNIX timestamp when this user made their last referral (GMT). If the user has not made any referrals, this will return false.
fields array An array of field objects that has been setup for this campaign and the values this user entered for each field.

Leaderboard Field Object

Item Type Description
field_name str The fields publicly shown label.
field_type str The field type. Possible values are: “email”, “firstname”, “lastname”, “number”, “text”, “textarea” or “date”
required int Indicates if the field is set to be required (1) or not (0).
value str The value the user entered.
Was this article helpful?
Dislike 0