Terms API Reference

Properties
GET /api/terms
POST /api/terms
GET /api/terms/:termId
PUT /api/terms/:termId
DELETE /api/terms/:termId

Terms

Terms in Stackla allow us to set the rules to ingest content from different networks (such as user-generated content from Social Networks) – it is defined as an ingestion query within the Stackla platform.

Properties

Field	Type	Value	Definition
id	integer		unique id for term
name	string		Name this new term
display_name	string		Display name
active	bool	`1` (true) `0` (false)	Flag – 1 or 0
type	string		post: Required Type of term for network. The value must be: `default` – ecal `page` – facebook, pinterest, rss `hashtag` – twitter, instagram `user` – twitter, instagram, gplus, youtube, flickr, pinterest `search` – twitter, gplus, youtube `location` – twitter, instagram `gallery` – flickr `set` – flickr `blog` – tumblr `atom` – rss `post` – sta_feed `weiboshow` `weibopage` `weibotopic` `page`
network	string	`twitter` `facebook` `instagram` `youtube` `gplus` `flickr` `pinterest` `tumblr` `rss` `ecal` `sta_feed` `weibo`	post: Required The source of social network
term	string		post: Required The term query
filter	string		Ingestion filter / keywords in CSV format
exclude_filter	string		Exclude-filter / keywords in CSV format
fan_filter	string		Fan-filter in CSV format
fan_exclude_filter	string		Fan-exclude-filter in CSV format
minimum_followers	integer		Threshold for minimum followers, available only for twitter – search and hashtag terms
moderate_text	enum	`publish` `queue` `disable` `exclude`	value wil be either
moderate_image	enum		same as moderate_text value
moderate_video	enum		same as moderate_text value
retweet_enable	bool
reply_enable	bool
reply_to_enable	bool
partial_match	bool
include_fan_content	bool
include_hashtag_in_comments	bool
include_official_content	bool
search_exact_phrase	string
verified_accounts	string		Include tweets of verified twitter accounts only
num_of_backfill	integer
whitelist_handles	string		White listing handle/username in CSV format
blacklist_handles	string		Black listing handle/username in CSV format
source_user_id	string		post: Required if `type` is one of this value [user, page, gallery, set] Original user id / identifier for the network
tags	array		Default tagging for ingested content
created	timestamp		Term’s creation time
modified	timestamp		Term’s modification time
last_ingestion_post	timestamp		Term’s last ingestion post time

GET terms

Retrieves all terms available in the Stack.

Resource URL

https://api.stackla.com/api/terms

Resource Details

Rate limited

Yes

Access scope

User

Request Parameters

Name	Mandatory	Request type	Description
page	No	query	Page number. Default value is 1
limit	No	query	Return limit define how many Terms will be return for each request. Default is 25. Maximum limit is 100.

POST terms

Creates a new Term in the Stack.

Resource URL

https://api.stackla.com/api/terms

Resource Details

Rate limited

Yes

Access scope

User

Request Parameters

No additional request parameters are available.

GET terms/:termId

Retrieves a specific Term available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/terms/:termId

Resource Details

Rate limited

Yes

Access scope

User

Request Parameters

Name	Mandatory	Request type	Description
termId	Yes	Request type	ID of the Term

PUT terms/:termId

Updates a specific Term available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/terms/:termId

Resource Details

Rate limited

Yes

Access scope

User

Request Parameters

Name	Mandatory	Request type	Description
termId	Yes	endpoint	ID of the Term

DELETE terms/:termId

Deletes a specific Term available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/terms/:termId

Resource Details

Rate limited

Yes

Access scope

User

Request Parameters

Name	Mandatory	Request type	Description
termId	Yes	endpoint	ID of the Term