Visual UGC Docs
Search
K

Moderationviews API Reference

Moderationviews

Moderationview allows users to save the view of a Moderation page, including content filter and the hide/show columns.

Properties

Field
Type
Value
GET
POST
PUT
Definition
id
integer
unique id for moderation view
view_name
string
Moderationview's name
type
bool
user
access_type
string
public
stack_id
integer
owner_id
integer
column
object
Moderationview's columns
columns_select_col
boolean
Option to show 'select' column
columns_pin_col
boolean
Option to show 'pin' column
columns_scheduled_col
boolean
Option to show 'scheduled' column
columns_platform_col
boolean
Option to show 'platform' column
columns_user_col
boolean
Option to show 'user' column
columns_name_col
boolean
Option to show 'name' column
columns_avatar_col
boolean
Option to show 'avatar' column
columns_content_col
boolean
Option to show 'content' column
columns_preview_col
boolean
Option to show 'preview' column
columns_created_col
boolean
Option to show 'created' column
columns_ingested_col
boolean
Option to show 'ingested' column
columns_status_col
boolean
Option to show 'status' column
columns_disabled_reason_col
boolean
Option to show 'disabled reason' column
columns_last_moderated_col
boolean
Option to show 'last moderated' column
columns_moderator_col
boolean
Option to show 'moderator' column
columns_terms_col
boolean
Option to show 'terms' column
columns_tags_col
boolean
Option to show 'tags' column
columns_type_col
boolean
Option to show 'type' column
columns_star_col
boolean
Option to show 'star' column
columns_abuse_col
boolean
Option to show 'abuse' column
columns_no_purge_col
boolean
Option to show 'Purgeable' column
columns_num_votes
boolean
Option to show 'num votes' column
columns_last_comment_queued_at
boolean
Option to show 'last comment queued at' column
columns_greatest_score
boolean
Option to show 'greatest score' column
columns_actions_col
boolean
Option to show 'actions' column
filter
object
Filter criteria
filter_value_content_search
string
String
filter_value_origin
string
Network types in CSV
filter_value_media
string
Media types in CSV
filter_value_abuse
boolean
filter_value_filter_by_claimed
string
Filter criteria claimed_only
filter_value_filter_by_geolocation
boolean
filter_value_tags
string
tag ids in CSV
filter_value_terms
string
term ids in CSV
other
object
Additional config
other_all_content_length
integer
Number of items per page
other_live_updates
boolean
other_display
string
table
date
object
Date range filter
date_range_from
string
ISO Date Time string
date_range_to
string
ISO Date Time string
sort_by
string
This is an option for sorting. The value will need to be one of the following: newest
created_at
timestamp
Moderationview's creation time
updated_at
timestamp
Moderationview's modification time

GET moderationviews

Retrieves all modertion views available in the Stack.

Resource URL

https://api.stackla.com/api/moderationviews

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

No additional request parameters are available.

POST moderationviews

Creates a new moderation view in the Stack.

Resource URL

https://api.stackla.com/api/moderationviews

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

No additional request parameters are available.

GET moderationviews/:moderationviewId

Retrieves a specific moderation view available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/moderationviews/:moderationviewId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
moderationviewId
Yes
endpoint
ID of the Moderation view

PUT moderationviews/:moderationviewId

Updates a specific moderation view available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/moderationviews/:moderationviewId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
moderationviewId
Yes
endpoint
ID of the Moderation view

DELETE moderationviews/:moderationviewId

Deletes a specific moderation view available in the Stack by its ID.

Resource URL

https://api.stackla.com/api/moderationviews/:moderationviewId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
moderationviewId
Yes
endpoint
ID of the Moderation view

Users

Users are resources that have access to the Visual UGC admin panel. Users can't get created via API, but instead are created by individuals following the invitation flow.

Properties

User Id Username First name Last name Email Notes on User User's last login datetime User's creation time User's modification time
Field
Type
Value
PUT
Definition
id
integer
username
string
name
string
surname
string
email
string
description
string
display_timezone
string
Timezone used when displaying date time strings
distances
string
metric imperial
Distance unit system to use when handling geo location distances
acl_groups
string or array
Admin = 1 Moderator = 2 Developer = 3
A list of acl group ids, comma separated or JSON array when used in JSON body
last_login
datetime
created_at
timestamp
updated_at
timestamp

GET users

Retrieves all users available in the Stack.

Resource URL

https://api.stackla.com/api/users

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 Users will be return for each request. Default is 25. Maximum limit is 100.
order_by
No
query
Return Users ordered by either id, name, email, surname, username, created. Sorts by id by default.
order_by_direction
No
query
Return ordered list of Users in either ascending (asc) or descending (desc) direction. Default is asc.

GET users/:userId

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

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
userId
Yes
Request type
ID of the User

PUT users/:userId

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

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
userId
Yes
endpoint
ID of the User

DELETE users/:userId

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

Resource URL

https://api.stackla.com/api/users/:userId

Resource Details

Rate limited
Yes
Access scope
User

Request Parameters

Name
Mandatory
Request type
Description
userId
Yes
endpoint
ID of the User