UGC Techdocs
  • Introduction
  • Guides
    • Analytics
      • Tracking UGC on Adobe Analytics
      • Tracking Widget interactions with Google Analytics
    • Direct Uploader
      • How to add Custom Data to Direct Uploader
      • How to capture Custom Data on Direct Uploader
      • How to automatically tag data on Direct Uploader
      • How to Customize error messages on Direct Uploader
      • How to Track Direct Uploader form submissions with Google Analytics (Universal & GA 4)
    • Data Templates
      • Creating a Data Template
    • Rights via Registration
      • Capture Custom Data on Rights by Registration Form
      • Styling Rights via Registration Form
    • REST API
      • Caching REST API results for optimization
      • Posting content into Nosto via Tile API
      • Posting images into Nosto via Tile API
    • Onsite Widgets (2.0)
      • Blank Canvas
        • How to Use the Blank Canvas to Create a Twitter Count Widget
        • Creating an Auto-Scrolling Carousel using Blank Canvas
        • Creating Gallery Widget by Using the Blank Canvas Widget
        • Creating a simple Hover effect using Blank Canvas
        • Creating a Word Cloud using Blank Canvas
        • Creating Your Widget by Using the Blank Canvas
      • Bind your own Events
      • Creating a Grid Widget from Waterfall
      • Create a Q&A Widget using Data Templates
      • Displaying a Widget in a Mobile App
      • Dynamically Specify Products to Display in Widget
      • Dynamically specify what Tile to display in a Widget
      • How to add a title / subtitle to a widget
      • How to localize the load more button on widgets
      • How to overlay existing Google Map with the UGC Map Widget
      • Styling cross-sellers on Grid and Carousel Widgets
      • How to Load External JS and CSS into Widgets
      • Profiling Widget Performance
      • Re-targeting with Widgets and Facebook Pixel
      • Render Widget filters dynamically
      • Styling Carousel Widget
      • Styling Grid Widget
      • Styling Masonry Widget
      • Styling Waterfall Widget
      • Styling Widget Expanded Tile
      • Styling Widget Shopspots
      • Using Web Fonts in Widgets
    • Digital Screens
      • Customizing Carousel Event Screen
      • Customizing Mosaic Event Screen
      • Customizing Scrollwall Event Screen
      • Customizing the Mosaic Event Screen to Have 9 Even Tiles
    • Email
      • Adding Location to an Email Tile
      • Styling the Email Widget
    • Integrations
      • DoubleClick
        • UGC Ads with Nosto and Google DoubleClick
      • Zapier
        • Consuming UGC Webhooks via Zapier
      • Mailchimp
        • Bring Social Content into a Mailchimp Campaign
    • Webhooks
      • Trigger notifications when content is in the moderation queue
  • Widgets
  • API Docs
    • JavaScript API
      • Widgets
        • Introduction
        • API Reference for Content Widgets
        • API Reference for Blank Canvas
        • API Reference for Map Widget
      • Digital Screens
        • Introduction
        • API Reference
    • Content API
      • Reference
    • REST API
      • Reference
        • Filters API
        • Moderation Views API
        • Tags API
        • Terms API
        • Tiles API
        • Users API
        • Widgets API
        • Automation Rules API
        • REST API Reference Widgets style and config
      • Best Practices
    • Webhooks
  • Enterprise Tools
    • Automation Rules
      • Triggers
      • Actions
      • Samples
    • Data Templates
    • User Access Control (UAC)
    • Single Sign On (SSO)
    • Enterprise Admin User Interface (EAUI)
    • Zapier
  • Commerce Tools
    • Product Feeds
    • Widget Implementation
    • Reporting
    • Integrations
      • Google Tag Manager
      • Magento
      • SalesForce Commerce Cloud
      • Shopify
      • Shopify Add To Cart
        • Global Variant Mapping for Add to Cart
        • Customise Add to Cart Widget Experience
  • Analytics
    • Google Analytics 4
      • Getting Started
      • Widgets Events
      • E-commerce Events
      • Email Events
  • Terms of Use
Powered by GitBook
On this page
  • Terms
  • Properties
  • GET terms
  • POST terms
  • GET terms/:termId
  • PUT terms/:termId
  • DELETE terms/:termId

Was this helpful?

  1. API Docs
  2. REST API
  3. Reference

Terms API

PreviousTags APINextTiles API

Was this helpful?

Terms

Terms in Nosto's UGC 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 Nosto's platform.

Properties

Field
Type
Value
POST
PUT
Definition

id

integer

X

X

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

✔

X

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

✔

X

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

✔

✔

moderate_image

enum

publish queue disable exclude

✔

✔

moderate_video

enum

publish queue disable exclude

✔

✔

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

✔

X

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

X

X

Term's creation time

modified

timestamp

X

X

Term's modification time

last_ingestion_post

timestamp

X

X

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

Properties
GET /api/terms
POST /api/terms
GET /api/terms/:termId
PUT /api/terms/:termId
DELETE /api/terms/:termId
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top