SocialOS API | Build vertical social networks and collaborative apps infused with blockchain

Build vertical social networks and collaborative apps infused with blockchain

The SocialOS Developer Hub

PeopleBrowsr's core technology, SocialOS, empowers individuals, government and enterprise to rapidly build vertical social networks and innovative Social Apps infused with blockchain.
Trusted by major banks and governments, SocialOS integrates with the apps you love in the environments you depend on with state of the art security.
Integrations with Stellar, Ethereum, POA and Loom blockchains simplify DApp setup.

SocialOS is part of the Kred Developer Ecosystem, including Kred Scores, Kred NFTs, and Kred Domains.

Guides    API Reference

Data Definitions

Limits

max_currency = 3
max_interval = 10
max_type = 35
max_status = 35
max_tag = 75
max_domain = 75
max_id = 75
max_email = 75
max_date = 75
max_address = 75
max_name = 200
max_url = 2000
max_subject = 2000
max_desc = 20000
max_text = 1000000

min_token = 0
max_token = 125

Account

id = ObjectId
user = Reference(User)

global_id = String(unique, length=max_name)
app = String(length=max_name)
app_private = Boolean

name = String(unique_with='domain', length=max_id)
domain = String(length=max_domain)
address = String(unique, length=max_address)
email = Email
private = Boolean

created = Int
modified = Int
updated = Int
type = String(length=max_type)

tags = List(String(length=max_tag))
settings = Dict
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))
limits = Dict

options = Map(String)
properties = List(Map(String))

User

id = ObjectId
account = Reference(Account)
global_id = String(unique, length=max_name)
app = String(length=max_name)
app_private = Boolean

name = String(unique_with='domain', length=max_id)
domain = String(length=max_domain)
address = String(unique, length=max_address)
email = Email

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
type = String(length=max_type)

geo = Embed(Geo)
bio = Embed(Bio)
analytics = Embed(Analytics)
refs = Map(Embed(Refs))


networks = List(Reference(Network))
folders = List(Reference(Folder))
pools = List(Reference(Pool))

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))
limits = Dict

permissions = Dict
role = String(length=max_type)

options = Map(String)
properties = List(Map(String))

kred = Reference(Kred)

Contact

id = ObjectId
account = Reference(Account)
owner = Reference(User)
user = Reference(User)
face = Reference(Face)
persona = Reference(Persona)

company = Reference(Company)
group = Reference(Group)
groups = List(Reference(Group))
invites = List(Reference(Invite))


address = String(length=max_address)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

app = String(length=max_name)
app_private = Boolean

type = String(length=max_type)

email = Email


first_name = String(length=max_name)
middle_name = String(length=max_name)
last_name = String(length=max_name)
name = String(length=max_name)
name_prefix = String(length=max_name)
name_suffix = String(length=max_name)
title = String(length=max_name)
description = String

screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)
foreign_id = String(length=max_name)
avatar = String(length=max_url)

networks = List(Reference(Network))

position = String(length=max_name)
organisation = String(length=max_name)


street = List(String(length=max_name))
city = String(length=max_name)
county = String(length=max_name)
state = String(length=max_name)
country = String(length=max_name)
postcode = String(length=max_id)
phone = String(length=max_id)
phone_ah = String(length=max_id)
mobile = String(length=max_id)
fax = String(length=max_id)
web = String(length=max_url)
home = String(length=max_url)


created = Int
modified = Int
updated = Int
verified = Int
confirmed = Int
visited = Int


geo = Embed(Geo)
bio = Embed(Bio)
analytics = Embed(Analytics)

tags = List(String(length=max_tag))
systags = List(String(length=max_tag))
autogroups = List(String(length=max_tag))
pinned = Int
favorite = Int

data = Dict
social = List(Map(String))
media = List(Dict)

options = Map(String)
properties = List(Map(String))

status = String(length=max_status)
flags = List(String(length=max_status))

do_not_send = Boolean
do_not_call = Boolean
do_not_track = Boolean

source = String(length=max_name)
quality = Int
condition = String(length=max_name)


last_post = Dict
recent_posts = List(Reference)

kred = Reference(Kred)
rel = Reference(Relation)
profile = Reference(Social)

refresh = Boolean
refreshed = Int

sync = List(Dict)
via = Dict

Award

id = ObjectId
type = String(length=max_type)

account = Reference(Account)
user = Reference(User)
company = Reference(Company)

name = String
text = String
description = String

private = Boolean

networks = List(Reference(Network))


created = Int
modified = Int
updated = Int
awarded = Int

tags = List(String(length=max_tag))
style = Embed(Style)

points = Int(default=100)

counts = Map(Int)

options = Map(String)
properties = List(Map(String))

status = String(length=max_status)
flags = List(String(length=max_status))

Moment

id = ObjectId
type = String(length=max_type)

award = Reference(Award)
account = Reference(Account)
owner = Reference(User)
user = Reference(User)
contact = Reference(Contact)
kred = Reference(Kred)
social = Reference(Social)
company = Reference(Company)

influence = Int
outreach = Int

name = String
text = String

private = Boolean
screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)
source = String(length=max_name)
foreign_id = String(length=max_name)
avatar = String(length=max_url)

networks = List(Reference(Network))


created = Int
time = Int

tags = List(String(length=max_tag))
style = Embed(Style)

options = Map(String)
properties = List(Map(String))

status = String(length=max_status)
flags = List(String(length=max_status))

Badge (Moment)

type = String(default='badge)

Achievement (Moment)

type = String(default='achievement)

Friend (Contact)

type = String(default='friend)

Follower (Contact)

type = String(default='follower)

Engagement (Contact)

type = String(default='engagement)

Connection (Contact)

type = String(default='connection)
stage = String(default='request)
contact = Reference(Contact)

Address (Contact)

type = String(length=max_type, default='address)
contact = Reference(Contact)

SocialProfile

id = String
type = String
source = String
name = String
screen_name = String
screen_name_lower = String
url = URL
avatar = URL
friends = Int
followers = Int

SocialPhoto

type = String
source = String
url = URL
primary = Boolean

SocialOrganisation

name = String
title = String
start = String
end = String
current = Boolean
url = URL

Social

id = ObjectId
type = String(length=max_type)

name = String(length=max_name)
first_name = String(length=max_name)
last_name = String(length=max_name)
screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)
address = String(length=max_address)

source = String
foreign_id = String

private = Boolean

created = Int
modified = Int
updated = Int

bio = Embed(Bio)
geo = Embed(Geo)
analytics = Embed(Analytics)


influence = Int
outreach = Int
communities = Dict

verified = Boolean


counts = Map(Int)


profiles = Map(Embed(SocialProfile))


photos = List(Embed(SocialPhoto))
organisations = List(Embed(SocialOrganisation))
demographics = Dict

data = Dict


flags = List(String)

Watch

id = ObjectId
type = String
owner = Reference(User)
user = Reference(User)
contact = Reference(Contact)
created = Int
rank = Int
hash = String

Ignore

id = ObjectId
type = String
owner = Reference(User)
user = Reference(User)
contact = Reference(Contact)
created = Int
rank = Int
hash = String

Domain

id = ObjectId
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

name = String(length=max_domain)
path = String(length=max_domain)
type = String(length=max_type)
alias = String

style = Embed(PageStyle)
bio = Embed(Bio)
geo = Embed(Geo)
analytics = Embed(Analytics)

authoritative = Boolean

admin = Reference(Contact)
billing = Reference(Contact)
contact = Reference(Contact)
technical = Reference(Contact)

created = Int
modified = Int
updated = Int
provisioned = Int
start = Int
end = Int
expires = Int
term = String
auto_renew = Boolean

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

status = String(length=max_status)

status_changed = Int
last_status = String(length=max_status)

flags = List(String(length=max_status))

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

options = Map(String)
properties = List(Map(String))

Persona

id = ObjectId
user = Reference(User)

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

name = String(unique_with='domain', length=max_id)
domain = String(length=max_domain)
address = String(unique, length=max_address)
email = Email

created = Int
modified = Int
updated = Int
verified = Int

geo = Embed(Geo, default=Geo)
bio = Embed(Bio, default=Bio)
style = Embed(Style, default=Style)
analytics = Embed(Analytics, default=Analytics)
networks = List(Reference(Network))

contact = Reference(Contact)
refs = Map(Embed(Refs))

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))
limits = Dict

default = Boolean

options = Map(String)
properties = List(Map(String))
social = List(Map(String))

kred = Reference(Kred)
influence = List(Map(Int))
outreach = List(Map(Int))

Portfolio

id = ObjectId
user = Reference(User)
persona = Reference(User)

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
personas = List(Reference(Persona))
count = Int
data = Dict

Link

user = Reference(User)
confidence = Float
linktype = String(length=max_type)

created = Int
modified = Int
updated = Int

Identity

id = ObjectId

user = Reference(User)
links = List(Embed(Link))

type = String(length=max_type)


identities = List(Reference(User))

Linked

user = Reference(User, unique)
linked = Dict
secondary = Dict
private = Boolean

OAuthCode

id = ObjectId

app = ObjectId
user = ObjectId

code = String(length=max_token)
status = String(length=max_status)
permissions = Dict
requests = Int


created = Int
invalidate = Int
expiry = Int


key = ObjectId

Credentials

id = ObjectId

user = ObjectId(unique)
data = Dict
auth = Reference(Auth)
synced = Int

Role

id = ObjectId

name = String(length=max_name, unique_with='app)

app = ObjectId
app_private = Boolean


created = Int
modified = Int

tags = List(String(length=max_tag))
status = String(length=max_status)
flags = List(String(length=max_status))

permissions = Map(List(String))

Key

id = ObjectId

user = ObjectId
app = ObjectId
app_private = Boolean

name = String(length=max_name)
token = String(unique, min_length=min_token, length=max_token)
type = String(length=max_type)


created = Int
modified = Int
accessed = Int
failed = Int
errored = Int
ttl = Int
expires = Int  
hold_until = Int


accesses = Int
failures = Int
successive_failures = Int


errors = Int
error = String

tags = List(String(length=max_tag))
status = String(length=max_status)
flags = List(String(length=max_status))

roles = List(Reference(Role))
permissions = Dict

requests = Int


data = Dict

Session

id = ObjectId
uuid = UUID(binary=False)
code = String(length=max_name)

user = Reference(User)
key = Reference(Key)
app = Reference(App)
app_private = Boolean

type = String(length=max_type)


created = Int
modified = Int
accessed = Int
expires = Int  
hold_until = Int
permanent = Boolean


accesses = Int
status = String(length=max_status)


data = Dict
device = Dict
notifications = Boolean

Shadow

id = ObjectId

key = ObjectId(unique)
hash = String

Access

id = ObjectId

type = String(default='access)
record_type = String

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
item = Reference(unique_with='user)
access = String(choices=(read', 'write', 'admin))

created = Int
expires = Int

Share (Access)

type = String(default='share)

Admin

id = ObjectId
app = ObjectId
app_private = Boolean

name = String(unique, length=max_id)
domain = String(unique_with='name', length=max_domain)
address = String(unique, length=max_url)
email = String(length=max_url)
private = Boolean

partner = Reference(Partner)

created = Int
modified = Int
updated = Int
type = String(length=max_type)

geo = Embed(Geo)
bio = Embed(Bio)
refs = Map(Embed(Refs))

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))
limits = Dict

permissions = Dict
role = String

AdminKey

id = ObjectId

admin = ObjectId
app = ObjectId
app_private = Boolean

name = String(length=max_name)
token = String(min_length=min_token, length=max_token)
type = String(length=max_type)


created = Int
modified = Int
accessed = Int
failed = Int
errored = Int
ttl = Int
expires = Int  
hold_until = Int


accesses = Int
failures = Int
successive_failures = Int


errors = Int
error = String

tags = List(String(length=max_tag))
status = String(length=max_status)
flags = List(String(length=max_status))

role = Reference(Role)
permissions = Dict
requests = Int

AdminShadow

id = ObjectId

adminkey = ObjectId
hash = String

AppUrls

home = String(length=max_url)
docs = String(length=max_url)
code = String(length=max_url)

App

id = ObjectId
partner = Reference(Partner)

name = String(unique, length=max_id)
type = String(length=max_type)
description = String(unique)
urls = Embed(AppUrls)
email = String(length=max_url)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))
limits = Dict

permissions = Dict
role = String(length=max_type)

style = Embed(Style)
analytics = Embed(Analytics)
options = Map(String)
properties = List(Map(String))


ledger = Reference(Ledger)
currency = String

AppKey

id = ObjectId

app = ObjectId
app_private = Boolean

user = ObjectId
admin = ObjectId

name = String(length=max_name)
token = String(min_length=min_token, length=max_token)
type = String(length=max_type)


created = Int
modified = Int
accessed = Int
failed = Int
errored = Int
ttl = Int
expires = Int  
hold_until = Int


accesses = Int
failures = Int
successive_failures = Int


errors = Int
error = String

status = String(length=max_status)

role = Reference(Role)
permissions = Dict
requests = Int

AppUser

id = ObjectId
account = Reference(Account)
owner = Reference(User)
user = Reference(User)

name = String(length=max_name)

app = ObjectId
app_private = Boolean

status = String(length=max_status)
plan = Reference(Plan)
deal = Reference(Deal)

analytics = Embed(Analytics)

sequence = Int
counts = Map(Int)
data = Dict

options = Map(String)
properties = List(Map(String))


created = Int
modified = Int
accessed = Int
expires = Int  

APIKey

id = ObjectId
api = String
account = Reference(Account)
user = Reference(User)
app = Reference(App)


url = URL
key = String
secret = String


auth_url = URL


created = Int
modified = Int
accessed = Int

private = Boolean
status = String(length=max_status)
flags = List(String(length=max_status))

permissions = Map(List(String))

Message

id = ObjectId
domain = String(length=max_domain)
global_id = String(unique, length=max_name)

account = Reference(Account)
user = Reference(User)
persona = Reference(Persona)
contact = Reference(Contact)

created = Int
modified = Int
updated = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
about = String(length=max_name)

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')


networks = List(Reference(Network))


folders = List(Reference(Folder))

time = Int
date = String(length=max_date)
subject = String(length=max_subject)
more = String(length=max_text)

to = List(Reference(User))
cc = List(Reference(User))
bcc = List(Reference(User))
attn = List(Reference(User))

geo = Embed(Geo)
analytics = Embed(Analytics)

refs = Map(Embed(Refs))
mentions = List(Reference(User))
cards = Map(Reference(Card))
revisions = List(Embed(Revision))
attachments = List(Reference(File))

tags = List(String(length=max_tag))
media = List(Dict)

data = Dict
counts = Map(Int)
period = Int
interval = Int

parent = Reference
path = String
rpath = String

language = String
status = String(length=max_status)
flags = List(String(length=max_status))
sieve = String(default='unready)
ttl = Int
expires = Int

options = Map(String)
properties = List(Map(String))

Card

id = ObjectId
url = String(unique)
urls = List(String)

status = Int
data = Dict

created = Int
updated = Int
modified = Int
checked = Int
visited = Int
visits = Int
group = Int

Data

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)

created = Float
modified = Float
updated = Float

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')


network = Reference(Network)
table = Reference(Table)
site = Reference(Site)
folder = Reference(Folder)
company = Reference(Company)

time = Float

tags = List(String(length=max_tag))
geo = Embed(Geo)

path = String

status = String(length=max_status)
flags = List(String(length=max_status))
sieve = String(default='unready)

properties = List(Map(String))
values = Map(Decimal)

Analysis

id = ObjectId
global_id = String(unique, length=max_name)

account = Reference(User)
owner = Reference(User)
user = Reference(User)

created = Float
modified = Float
updated = Float

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)

period = Int
interval = Int

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')


network = Reference(Network)
table = Reference(Table)
site = Reference(Site)
folder = Reference(Folder)
company = Reference(Company)

time = Float

tags = List(String(length=max_tag))
geo = Embed(Geo)

path = String

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

totals = Map(Decimal)
minima = Map(Decimal)
maxima = Map(Decimal)
counts = Map(Decimal)
first = Map(Decimal)
last = Map(Decimal)

Info

id = ObjectId

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)
pools = List(Reference(Pool))

parent = Reference
path = String
attach = Boolean

created = Float
modified = Float
updated = Float
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Note

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
contact = Reference(Contact)
persona = Reference(Persona)

name = String(length=max_name)
networks = List(Reference(Network))
campaigns = List(Reference(Campaign))
projects = List(Reference(Project))

company = Reference(Company)
deal = Reference(Deal)
ticket = Reference(Ticket)
issue = Reference(Issue)
action = Reference(Action)
domain = Reference(Domain)

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Action

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
assigned = Reference(User)

contact = Reference(Contact)
persona = Reference(Persona)

action = String
name = String(length=max_name)
source = String(length=max_name)
address = Email
code = String(length=max_name)

networks = List(Reference(Network))
campaigns = List(Reference(Campaign))
projects = List(Reference(Project))

company = Reference(Company)
deal = Reference(Deal)
ticket = Reference(Ticket)
issue = Reference(Issue)
domain = Reference(Domain)

parent = Reference
path = String
attach = Boolean

method = String

created = Int
modified = Int
updated = Int
expires = DateTime

start = Int
end = Int
reminder = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Invite (Action)

type = 'invite'

Project

id = ObjectId

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)

app = String(length=max_name)
app_private = Boolean

parent = Reference
path = String

type = String(default='project', length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

actions = Map(Int)
results = Map(Int)
summary = Dict

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Ticket

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
assigned = Reference(User)

contact = Reference(Contact)
persona = Reference(Persona)

action = String
name = String(length=max_name)

company = Reference(Company)
deal = Reference(Deal)
project = Reference(Project)
domain = Reference(Domain)

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expires = DateTime

start = Int
end = Int
reminder = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Issue

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
assigned = Reference(User)

contact = Reference(Contact)
persona = Reference(Persona)

action = String
name = String(length=max_name)
networks = List(Reference(Network))
projects = List(Reference(Project))

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expires = DateTime

start = Int
end = Int
reminder = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Deal

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
contact = Reference(Contact)
persona = Reference(Persona)
domain = Reference(Domain)

action = String
name = String(length=max_name)
networks = List(Reference(Network))
campaigns = List(Reference(Campaign))

company = Reference(Company)
product = Reference(Product)
plan = Reference(Plan)
payment = Reference(Payment)

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expiry = Int
expires = DateTime

start = Int
end = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
description = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

features = Dict

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Limit

id = ObjectId

user = Reference(User)
account = Reference(Account)

count = Int
limit = Int(default=100)

action = String
created = Int
modified = Int
expires = Int

Company

id = ObjectId

user = Reference(User)
account = Reference(Account)
contact = Reference(Contact)

name = String(length=max_name, unique_with='account)

registration = String


street = List(String(length=max_name))
city = String(length=max_name)
county = String(length=max_name)
state = String(length=max_name)
country = String(length=max_name)
postcode = String(length=max_id)
phone = String(length=max_id)
phone_ah = String(length=max_id)
mobile = String(length=max_id)
fax = String(length=max_id)
web = String(length=max_url)
email = Email
industry = String(length=max_name)
social = List(Map(String))


avatar = URL
logo = URL


bio = Embed(Bio)
geo = Embed(Geo)
analytics = Embed(Analytics)
style = Embed(Style)

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

description = String(length=max_text)

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
metadata = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

media = List(Dict)

do_not_send = Boolean
do_not_call = Boolean
do_not_track = Boolean

source = String(length=max_name)
quality = Int
condition = String(length=max_name)


last_post = Dict
recent_posts = List(Reference)

Count

id = ObjectId
type = String

user = Reference(User)
domain = String
url = String

name = String
time = Float
ip = String

period = Int
interval = Int

data = Dict
count = Int

Visit (Count)

type = String(default='visit)
geo = Embed(Geo)

Visitor (Count)

type = String(default='visitor)
geo = Embed(Geo)

Counter

id = ObjectId
type = String
name = String
period = Int
interval = Int

stats = Dict

Total

id = ObjectId
type = String
name = String
period = Int
interval = Int

stats = Dict

GeoIP

id = ObjectId
ip = String(unique)
data = Dict

Table

id = ObjectId
app = String(length=max_name)
app_private = Boolean

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)


namespace = String(length=max_name, unique)
fields = List(Map(String))

type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

ttl = Int
options = Map(String)

properties = List(Map(String))

Schema (Table)

pass

Record

id = ObjectId
table = Reference(Table)

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)
time = Float

path = String

created = Int
modified = Int
updated = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

tags = List(String(length=max_tag))

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Object

id = ObjectId
schema = Reference(Schema, db_field='class)

created = Float
updated = Float

data = Dict

Setting

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
name = String(length=max_name)
parent = Reference
time = Float

path = String

created = Int
modified = Int
updated = Int

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

item_type = String(length=max_name)
item = Reference

tags = List(String(length=max_tag))

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

data = Dict

properties = List(Map(String))

Global

id = ObjectId
parent = Reference(Setting)
app = String(length=max_name)
cls = String(length=max_name)
name = String(length=max_name)

created = Int
modified = Int
updated = Int

type = String(length=max_type)
app_private = Boolean

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

data = Dict

Cache

id = ObjectId
user = Reference(User)
name = String(length=max_name)

parent = Reference
path = String
attach = Boolean

created = Int
modified = Int
updated = Int
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Event

id = ObjectId

account = ObjectId
user = ObjectId
admin = ObjectId
parents = List(ObjectId)

app = ObjectId
app_private = Boolean

type = String(length=max_type)
action = String(length=max_type)

time = Int(default=time.time)

tags = List(String(length=max_tag))
data = Dict
text = String(length=max_text)
geo = Dict

item_type = String
item = Reference
related = Reference

name = String
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

private = Boolean
sharing = String(length=max_type, default='account)


processed = Int
result = Dict

properties = List(Map(String))

Job

id = ObjectId
type = String(length=max_type)

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
task = Reference(Task)
request = Reference(Request)

app = ObjectId
app_private = Boolean

action = String
source = String
path = String
uuid = UUID
queue_id = String

tags = List(String(length=max_tag))
data = Dict
result = Dict

status = String(length=max_status)
flags = List(String(length=max_status))


created = Int
modified = Int
updated = Int
started = Float
finished = Float

time = Int

properties = List(Map(String))

private = Boolean
sharing = String(length=max_type, default='account)

count = Int
progress = Float
processed = Int

suspendable = Boolean
restartable = Boolean

wait = List(Reference(Job))

error = String

Filter

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


action = String(choices=(add', 'repost', 'feed', 'stream', 'moderated))


terms = List(String)
require = List(String)
exclude = List(String)


targets = List(Reference)

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
auto_type = Boolean
description = String(length=max_desc)
ttl = Int

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Promotion

id = ObjectId

account = Reference(Account)
user = Reference(User)
brand = Reference(Brand)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


action = String


terms = List(String)
require = List(String)
exclude = List(String)


targets = List(Reference)

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
description = String(length=max_desc)
ttl = Int

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

View

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
matched = Int

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Analyser

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


action = String(choices=(add', 'repost', 'feed', 'stream', 'moderated))


terms = List(String)
require = List(String)
exclude = List(String)


targets = List(Reference)

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
description = String(length=max_desc)
ttl = Int

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Effect



module = String
action = String
keywords = Map(String)

Trigger

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


effects = List(Embed(Effect))
on_error = String(default='stop')


terms = List(String)
require = List(String)
exclude = List(String)

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Task

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


effects = List(Embed(Effect))
on_error = String(default='stop')


start = Int
stop = Int
interval = Int
repeat = Int

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Feeder

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


effects = List(Embed(Effect))
on_error = String(default='stop')


start = Int
stop = Int
interval = Int
repeat = Int

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Aggregate

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


effects = List(Embed(Effect))
on_error = String(default='stop')


start = Int
stop = Int
interval = Int
repeat = Int

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Report

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


function = String


effects = List(Embed(Effect))
on_error = String(default='stop')


start = Int
stop = Int
interval = Int
repeat = Int

created = Int
modified = Int
matched = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
description = String(length=max_desc)

options = Map(String)

counts = Map(Int)
status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

FilterControl

id = ObjectId
filter = Reference(Filter)
admin = Reference(Admin)
mode = String(choices=(user', 'admin', 'system), default='user)

Stack

id = ObjectId

account = Reference(Account)
user = Reference(User)

name = String(length=max_name)
type = String(length=max_type)
mode = String(default='smart)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
hits = Int
limit = Int(default=50)
items = List(Reference)
filters = List(Reference(Filter))

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
data = Dict

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

properties = List(Map(String))

Map

id = ObjectId

account = Reference(Account)
user = Reference(User)

name = String(length=max_name)
type = String(length=max_type)
mode = String(default='smart)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
hits = Int
limit = Int(default=50)
items = List(Reference)
filters = List(Reference(Filter))

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
data = Dict

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

properties = List(Map(String))

Set

id = ObjectId

account = Reference(Account)
user = Reference(User)

name = String(length=max_name)
type = String(length=max_type)
mode = String(default='smart)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
hits = Int
limit = Int(default=50)
items = List(Reference)
filters = List(Reference(Filter))

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
data = Dict

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

properties = List(Map(String))

Queue

id = ObjectId
user = Reference(User)

account = Reference(Account)
name = String(length=max_name)
type = String(length=max_type)
mode = String(default='smart)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
hits = Int
limit = Int(default=50)
items = List(Reference)
filters = List(Reference(Filter))

parent = Reference
path = String

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))
data = Dict

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

properties = List(Map(String))

Stream

id = ObjectId

app = String(length=max_name)
app_private = Boolean

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)
type = String(length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

filters = List(Reference(Filter))

options = Map(String)
properties = List(Map(String))

Stats

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

analytics = Map(Embed(Analytics))

filters = List(Reference(Filter))

properties = List(Map(String))

Script

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

code = String(length=max_text)
hash = String
version = Float
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))
ttl = Int

options = Map(String)

properties = List(Map(String))

Pool

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int

parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(default='stopped', length=max_status)
flags = List(String(length=max_status))

ttl = Int
options = Map(String)

properties = List(Map(String))

Annotation

id = ObjectId

pool = ObjectId
type = String(length=max_type)
key = String(length=max_name)

private = Boolean
sharing = String(length=max_type, default='space)

created = Int
modified = Int
updated = Int

tags = List(String(length=max_tag))
data = Dict
count = Int
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

Network

id = ObjectId

account = Reference(Account)
user = Reference(User)
grab = Reference(Grab)
app = Reference(App)
app_private = Boolean

name = String(length=max_name)
type = String(default='network', length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

membership = String(choices=['open', 'closed', 'moderated'], default='closed)

admins = Reference(List)
moderators = Reference(List)

style = Embed(Style)

created = Int
modified = Int
updated = Int
last = Int


start = Int
stop = Int

count = Int

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))

parent = Reference
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))
analytics = Embed(Analytics)

community = Reference(Community)

Channel (Network)

type = String(default='channel', length=max_type)
network = Reference(Network)

NetworkActions

id = ObjectId
network = Reference(Network)
user = Reference(User)

applied = Map(Embed(ActionField))
invited = Map(Embed(ActionField))
suspended = Map(Embed(ActionField))
locked = Map(Embed(ActionField))
stopped = Map(Embed(ActionField))
banned = Map(Embed(ActionField))

created = Int
modified = Int
updated = Int
last = Int

Repair

id = ObjectId
table = String
record = Reference
action = String(length=max_type)
created = Int
problem = String(length=max_desc)

data = String

status = String(length=max_status)
flags = List(String(length=max_status))

tags = List(String(length=max_tag))

Error

id = ObjectId
record = Reference
request = Dict
action = String(length=max_type)
created = Int
problem = String(length=max_desc)

status = String(length=max_status)
flags = List(String(length=max_status))

tags = List(String(length=max_tag))
data = Dict

Requests

id = ObjectId
period = Int
interval = Int

counts = Dict
times = Dict
bytes = Dict
status = Dict

tags = List(String(length=max_tag))

Activity

id = ObjectId
period = Int
interval = Int
network = Reference(Network)
tags = List(String(length=max_tag))

analytics = Dict

Cloud

id = ObjectId
period = Int
interval = Int
table = String(length=max_type)
field = String(length=max_type)
user = Reference(User)
network = Reference(Network)
tags = List(String(length=max_tag))

cloud = Map(Int)

Score

id = ObjectId
user = Reference(User)
network = Reference(Network)
tags = List(String(length=max_tag))

analytics = Embed(Analytics)

Trending

id = ObjectId

period = Int
interval = Int

user = Reference(User)
network = Reference(Network)
tags = List(String(length=max_tag))

analytics = Embed(Analytics)

Folder

id = ObjectId

account = Reference(Account)
user = Reference(User)
site = Reference(Site)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(default='folder', length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

tags = List(String(length=max_tag))
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)

properties = List(Map(String))

Space

id = ObjectId

account = Reference(Account)
user = Reference(User)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(default='folder', length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

tags = List(String(length=max_tag))
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)

properties = List(Map(String))

Site

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(default='folder', length=max_type)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

tags = List(String(length=max_tag))
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Group

id = ObjectId

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
share = Reference(Group)
parent = Reference(Group)

app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)

type = String(default='group', length=max_type)
subtype = String(length=max_name)
via = String(length=max_name)

source = String

private = Boolean
sharing = String(length=max_type, default='account)
access = String
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

tags = List(String(length=max_tag))
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

level = Int(default=1)
acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)

properties = List(Map(String))

view = List(String)

SubGroup (Group)

level = Int(default=2)

Ledger

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

name = String(length=max_name)
type = String(default='group', length=max_type)
currency = String

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int

tags = List(String(length=max_tag))
path = String

data = Dict
counts = Map(Int)

title = String(length=max_name)
description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Page

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
updated = Int
type = String(length=max_type)

text = String(length=max_text)

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')

folders = List(Reference(Folder))
networks = List(Reference(Network))

time = Int
date = String(length=max_date)
title = String(length=max_subject)

analytics = Embed(Analytics)

refs = Map(Embed(Refs))
attachments = List(Reference(File))
revisions = List(Revision)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

parent = Reference
name = String
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Post

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
updated = Int
type = String(length=max_type)

text = String(length=max_text)

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')

folders = List(Reference(Folder))
networks = List(Reference(Network))

time = Int
date = String(length=max_date)
title = String(length=max_subject)

analytics = Embed(Analytics)

refs = Map(Embed(Refs))
attachments = List(Reference(File))
revisions = List(Revision)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

parent = Reference
name = String
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

File

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
updated = Int
type = String(length=max_type)
mimetype = String(length=max_type)

name = String(length=max_name)
text = String(length=max_text)
content = File
metadata = Dict

private = Boolean
sharing = String(length=max_type, default='space)
visibility = String(length=max_type, default='visible')

folders = List(Reference(Folder))
networks = List(Reference(Network))

time = Int
date = String(length=max_date)
title = String(length=max_subject)

analytics = Embed(Analytics)

refs = Map(Embed(Refs))

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

parent = Reference
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

storage = String
bucket = String

options = Map(String)
properties = List(Map(String))

Image (File)

Template

id = ObjectId

account = Reference(Account)
user = Reference(User)
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
updated = Int
type = String(length=max_type)

code = String(length=max_text)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

folders = List(Reference(Folder))

time = Int
date = String(length=max_date)
title = String(length=max_subject)

revisions = List(Revision)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

parent = Reference
name = String
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Vote

id = ObjectId

account = Reference(Account)
user = Reference(User)
parent = Reference
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
type = String(length=max_type)

value = String

Tally

id = ObjectId

account = Reference(Account)
user = Reference(User)
parent = Reference
app = String(length=max_name)
app_private = Boolean

created = Int
modified = Int
type = String(length=max_type)

counts = Map(Int)

Shop

id = ObjectId

account = Reference(Account)
user = Reference(User)
identity = Reference(Identity)

created = Int
modified = Int
updated = Int

count = Int
sharing = String(length=max_type)
visibility = String(length=max_type, default='visible')

name = String(length=max_name)
type = String(length=max_type)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(default='stopped', length=max_status)
flags = List(String(length=max_status))


currency = String(length=3)

options = Map(String)
properties = List(Map(String))

Brand

id = ObjectId

account = Reference(Account)
user = Reference(User)
identity = Reference(Identity)

created = Int
modified = Int
updated = Int

count = Int
sharing = String(length=max_type)
visibility = String(length=max_type, default='visible')

name = String(length=max_name)
type = String(length=max_type)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(default='stopped', length=max_status)
flags = List(String(length=max_status))


currency = String(length=3)

options = Map(String)
properties = List(Map(String))

Customer (Contact)

type = String(default='customer)

Supplier (Contact)

type = String(default='supplier)

Product

id = ObjectId

account = Reference(Account)
user = Reference(User)
brand = Reference(Brand)

created = Int
modified = Int
updated = Int

count = Int
sharing = String(length=max_type)
visibility = String(length=max_type, default='visible')

name = String(length=max_name)
type = String(length=max_type)

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)
term = Int(default=366)  

description = String(length=max_desc)
image = Reference(Image)
media = Map(Reference(Image))

status = String(length=max_status)
flags = List(String(length=max_status))

features = Dict

options = Map(String)
properties = List(Map(String))

Plan (Product)

Item

product = Reference(Product)
qty = Decimal
price = Decimal
amount = Decimal
charges = Map(Decimal)
notes = String

Stock

id = ObjectId

account = Reference(Account)
user = Reference(User)

shop = Reference(Shop)
product = Reference(Product)

created = Int
modified = Int
updated = Int

tags = List(String(length=max_tag))

count = Int
price = Float

status = String(length=max_status)
flags = List(String(length=max_status))

Transaction

id = ObjectId

shop = Reference(Shop)
account = Reference(Account)
owner = Reference(User)
user = Reference(User)
customer = Reference(Customer)
deal = Reference(Deal)
domain = Reference(Domain)

created = Int
modified = Int
updated = Int
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
name = String(length=max_text)
ref = String(length=max_text)
xref = String(length=max_text)
email = String(length=max_text)

source = String

time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)
properties = List(Map(String))

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

currency = String(length=max_currency)
amount = Decimal

code = String
provider = String


charges = Map(Decimal)


items = List(Embed(Item))

Balance

id = ObjectId

shop = Reference(Shop)
account = Reference(Account)
owner = Reference(User)
user = Reference(User)
customer = Reference(Customer, unique)

created = Int
modified = Int
updated = Int
expires = DateTime

type = String(length=max_type)
app = String(length=max_name)
app_private = Boolean

text = String(length=max_text)
ref = String(length=max_text)
xref = String(length=max_text)
name = String(length=max_text)
email = String(length=max_text)

source = String
time = Int

tags = List(String(length=max_tag))
counts = Map(Int)

data = Dict
options = Map(String)

private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

status = String(length=max_status)
flags = List(String(length=max_status))

properties = List(Map(String))

currency = String(length=max_currency)
amount = Decimal


charges = Map(Decimal)


items = List(Embed(Item))

Cart (Transaction)

type = String(default='cart')

Coupon (Transaction)

type = String(default='coupon')

Order (Transaction)

type = String(default='order')

Invoice (Transaction)

type = String(default='invoice')

Sale (Transaction)

type = String(default='sale')

Gift (Transaction)

type = String(default='gift')

Reward (Transaction)

type = String(default='reward')

Purchase (Transaction)

type = String(default='purchase')

Subscription (Transaction)

type = String(default='subscription')

Credit (Transaction)

type = String(default='credit')

Journal (Transaction)

type = String(default='journal')

Payment (Transaction)

type = String(default='payment)
currency = String

Receipt (Transaction)

type = String(default='receipt')

Charge (Transaction)

type = String(default='charge')

Transfer (Transaction)

type = String(default='transfer')

Delivery (Transaction)

type = String(default='delivery')
shipping = Contact

TestRun

id = ObjectId(primary_key=True)

name = String(length=max_name)
host = String(length=max_name)
port = Int
protocol = String(length=max_name)
version = Float
start = Float
stop = Float
time = Float
tests = Int
errors = Int
status = String(length=max_status)

Request

id = ObjectId
uuid = UUID
user = Reference(User)
source = String(length=max_name)
api = String(length=max_name)
endpoint = String(length=max_name)
url = String(length=max_url)
args = List(String)
params = Dict
data = Dict

status = Int
response = String
created = Int
updated = Int

parent = Reference

Response

id = ObjectId
uuid = UUID
user = Reference(User)
source = String(length=max_name)
api = String(length=max_name)
endpoint = String(length=max_name)
url = String(length=max_url)
args = List(String)
params = Dict
data = Dict

status = Int
response = String
created = Int
updated = Int

parent = Reference

Log

id = ObjectId


url = String
verb = String
method = String
start = Float
arguments = List
keywords = Dict
admin = ObjectId
user = ObjectId
login = String
request_headers = Dict
text = String


status = String
content = String
length = Int
response_headers = Dict
stop = Float
time = Float


version = String
name = String
message = String
trace = String


run = String
line = Int


tags = List(String(length=max_tag))
data = Dict

Label

id = ObjectId

account = Reference(Account)
user = Reference(User)
status = String(length=max_status, default='active)

created = Int
modified = Int
updated = Int

private = Boolean

type = String(length=max_type)
parent = Reference
item = Reference
tags = List(String)

Relation

id = ObjectId
type = String(length=max_type)
source = String(length=max_name)

account = Reference(Account)
owner = Reference(User)
user = Reference(User)
face = Reference(Face)
persona = Reference(Persona)
contact = Reference(Contact)

app = Reference(App)
app_private = Boolean

name = String(length=max_name)
screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)
foreign_id = String(length=max_name)
avatar = String(length=max_url)
email = Email
description = String

status = String(length=max_status, default='active)
flags = List(String(length=max_status))

created = Int
modified = Int
updated = Int
confirmed = Int

muted = Boolean
pinned = Int

private = Boolean
sharing = String

tags = List(String)
analytics = Embed(Analytics)

Mute (Relation)

type = String(default='mute)

Property

id = ObjectId

account = Reference(Account)
user = Reference(User)
status = String(length=max_status, default='active)

created = Int
modified = Int
updated = Int

private = Boolean
sharing = String(length=max_type, default='account)

type = String(length=max_type)
parent = Reference
item = Reference
tags = List(String)

properties = List(Map(String))

Slot

id = ObjectId

account = Reference(Account)
user = Reference(User)
status = String(length=max_status, default='active)

created = Int
modified = Int
updated = Int

private = Boolean
sharing = String(length=max_type, default='account)

key = String
sort = String
priority = Int
unique_key = String

type = String(length=max_type)
record_type = String(length=max_type)
parent = Reference
tags = List(String)

item = Reference

path = String
depth = Int

Member

id = ObjectId
network = Reference(Network)
grab = Reference(Grab)

account = Reference(Account)
user = Reference(User)
persona = Reference(Persona)
contact = Reference(Contact)
parent = Reference
role = String(length=max_type)
analytics = Embed(Analytics)

name = String(length=max_name)
screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)
avatar = String(length=max_url)
email = Email
description = String

created = Int
modified = Int
updated = Int
joined = Int
expires = Int

mod_action = String
mod_action_expires = Int
mod_action_after = String

private = Boolean
sharing = String(length=max_type, default='account)

app = Reference(App)
app_private = Boolean

type = String(default='member', length=max_type)
tags = List(String)

status = String(length=max_status, default='active)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

permissions = Dict
privacy = Dict

Subscriber (Member)

grab = Reference(Grab)

RequestLog (Log)

ErrorLog (RequestLog)

request = Reference(RequestLog)

TestLog (ErrorLog)

DebugLog (Log)

Items

users = List(Reference(User))
messages = List(Reference(Message))
lists = List(Reference(List))
networks = List(Reference(Network))
pools = List(Reference(Pool))
annotations = List(Reference(Annotation))
info = List(Reference(Info))
cache = List(Reference(Cache))
apps = List(Reference(App))
stacks = List(Reference(Stack))
stats = List(Reference(Stats))
streams = List(Reference(Stream))
scripts = List(Reference(Script))
folders = List(Reference(Folder))
pages = List(Reference(Page))
files = List(Reference(File))
images = List(Reference(Image))
templates = List(Reference(Template))
events = List(Reference(Event))
requests = List(Reference(Requests))
activity = List(Reference(Activity))
clouds = List(Reference(Cloud))
scores = List(Reference(Score))
trending = List(Reference(Trending))

ListPage

id = ObjectId

list = Reference(List)
page = Int

items = Embed(Items)

List

id = ObjectId

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)

app = String(length=max_name)
app_private = Boolean

parent = Reference
path = String

type = String(default='list', length=max_type)
mode = String(default='smart)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int

count = Int
hits = Int
limit = Int

tags = List(String(length=max_tag))
smart_tags = List(String(length=max_tag))

data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

items = Embed(Items, )

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Campaign

id = ObjectId

account = Reference(Account)
user = Reference(User)
name = String(length=max_name)
description = String

source = String(length=max_name)
foreign_id = String(length=max_name)

app = String(length=max_name)
app_private = Boolean

parent = Reference
path = String

type = String(default='campaign', length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int
last = Int
start = Int
end = Int

count = Int

actions = Map(Int)
results = Map(Int)
summary = Dict

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Act

id = ObjectId

campaign = Reference(Campaign)
account = Reference(Account)
user = Reference(User)
customer = Reference(User)

app = ObjectId
app_private = Boolean
private = Boolean
sharing = String(length=max_type, default='account)

type = String(length=max_type)
created = Int
modified = Int
time = Int

tags = List(String(length=max_tag))
data = Dict
text = String(length=max_text)
action = String(length=max_text)
result = String(length=max_text)
geo = Dict

parent = Reference
path = String

status = String(length=max_status)
flags = List(String(length=max_status))

Kred

id = ObjectId
type = String(length=max_type)

account = Reference(Account)
user = Reference(User)
contact = Reference(Contact)

name = String(length=max_id)
address = String(length=max_address)
email = Email

source = String
foreign_id = String

screen_name = String(length=max_name)
screen_name_lower = String(length=max_name)

private = Boolean
sharing = String(length=max_type, default='account)

created = Int
modified = Int
updated = Int

bio = Embed(Bio)
geo = Embed(Geo)


influence = Int
outreach = Int

community_influence = Map(Int)
community_outreach = Map(Int)

communities = List(String)

followers = Int
friends = Int

posts = Int
listed = Int
verified = Boolean


mentions_in = Int
mentions_out = Int

replies_in = Int
replies_out = Int

reposts_in = Int
reposts_out = Int

links = Int
images = Int
videos = Int


flags = List(String)
stage = String

Point

id = ObjectId
type = String(length=max_type)
direction = String

account = Reference(Account)
kred = Reference(Kred)

source = String
message_id = String
foreign_id = String
origin = String
private = Boolean

screen_name_lower = String(length=max_name)


to_id = String
to_screen_name_lower = String(length=max_name)


from_id = String
from_screen_name_lower = String(length=max_name)


link = String
media = String


tags = List(String)


reply_id = String


repost_id = String


parent_id = String

time = Int
created = Int

text = String


influence = Int
outreach = Int
points = Float

communities = List(String)


image = Reference(Image)


data = Dict

Community

id = ObjectId
type = String(length=max_type)

account = Reference(Account)
user = Reference(User)
champion = Reference(User)

mode = String(choices=(user', 'message))

number = String
name = String
aliases = List(String)
code = String
title = String
description = String

network = Reference(Network)


community_id = String
leader_count = Int(default=1000)

leader_low = Int
leader_high = Int
leaders = Int

include = List(String)
exclude = List(String)


users = List(String)
exclude_users = List(String)

tags = List(String)
geo = Embed(Geo)

status = String(length=max_status)
flags = List(String(length=max_status))
private = Boolean

created = Int
modified = Int
updated = Int

start = Int
stop = Int

data = Dict

Leader

id = ObjectId
type = String(length=max_type)

community = Reference(Community)
number = String

kred = Reference(Kred)

source = String
foreign_id = String

screen_name_lower = String(length=max_name)


influence = Int
outreach = Int
community_influence = Int
community_outreach = Int

domain = String
url = String

created = Int
modified = Int

rank = Int

Heap

id = ObjectId
app = String(length=max_name)
app_private = Boolean

account = Reference(Account)
user = Reference(User)
name = String(length=max_name, unique)

type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

created = Int
modified = Int
updated = Int

count = Int
parent = Reference
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

description = String(length=max_desc)

acl = ObjectId

status = String(length=max_status)
flags = List(String(length=max_status))

ttl = Int
options = Map(String)

properties = List(Map(String))

Hook

id = ObjectId
label = String(unique)
app = String(length=max_name)
app_private = Boolean

account = Reference(Account)
user = Reference(User)
parent = Reference

name = String(length=max_name, unique_with='user)
description = String

type = String(length=max_type)
private = Boolean
sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')

api = String(length=max_name)
direction = String(choices=(in', 'out))
token = String
key = String


method = String(default='POST')
commands = List(String)
urls = List(URL)
endpoint = String


effects = List(Embed(Effect))
on_error = String(default='stop')

created = Int
modified = Int
updated = Int

count = Int
path = String

tags = List(String(length=max_tag))
data = Dict
counts = Map(Int)

status = String(length=max_status)
flags = List(String(length=max_status))

options = Map(String)
properties = List(Map(String))

Hash

id = ObjectId
type = String(length=max_type)
key = String

heap = Reference(Heap)
shard = String
db = String

data = Dict
raw = String

SysInfo

id = ObjectId
type = String(length=max_type)
key = String

data = Dict

Tracker

Click

id = ObjectId
tracker = Reference(Tracker)

url = URL
referrer = URL

created = Int
modified = Int

Base

id = ObjectId(db_field='_id)
account = Reference(Account)
user = Reference(User)
name = String(length=max_name)

type = String(length=max_type)
status = String(length=max_status)
private = Boolean

created = Int
modified = Int
updated = Int

tags = List(String(length=max_tag))
flags = List(String(length=max_status))

data = Dict

path = String
parent = Reference

Auth

source = String
domain = String

address = String
foreign_id = String
screen_name = String
screen_name_lower = String

updated = Float
activity = Float


token = String
secret = String


refreshed = Int
refresh_token = String


pooled = Boolean
limited = Int
errored = Int


used = Int
last_status = String


scopes = List(String)


credentials = Reference(Credentials)


encrypted = Boolean
salt = String

GrabRules

feeds = List(String)
grabs = List(Reference(Grab))


search = String


tags = List(String)
names = List(String)
terms = List(String)
bio = List(String)
include = List(String)
exclude = List(String)
realnames = List(String)


sentiment = Float
score = Float(default=-10)
rate = Float


reposts = Int
likes = Int
language = List(String)
country = List(String)
state = List(String)
city = List(String)
cc = List(String)
age = Int(default=86400)


link = Boolean
photo = Boolean
video = Boolean


liked = Boolean
reposted = Boolean
commented = Boolean


media = Boolean
engaged = Boolean
trending = Boolean
highlight = Boolean


profanity = Boolean
spam = Boolean
bots = Boolean


sort = String(default='recent)
order = String
count = Int(default=50)


members = Boolean
friends = Boolean
contacts = Boolean
all = Boolean

operator = String(default='and)

Grab

domain = String

sharing = String(length=max_type, default='account)
visibility = String(length=max_type, default='visible')


action = String


targets = List(Reference)


matched = Int

smart_tags = List(String(length=max_tag))
description = String(length=max_desc)
ttl = Int

options = Map(String)
counts = Map(Int)
properties = List(Map(String))


rules = Embed(GrabRules)


style = Embed(Style)


analytics = Embed(Analytics)


network = Reference(Network)
stack = Reference(Stack)
filter = Reference(Filter)
method = String(default='match)
systags = List(String)


live = Boolean
moderated = Boolean
roundrobin = Boolean
rate = Int


query = String
body = Dict
cached = Int


indexed = Int
subscribers = Int
trending = Float


stealth = Boolean
hash = String


start = Int
stop = Int(default=9999999999)


cta_url = String
cta_description = String


grabs = List(Reference(Grab))

Feed (Grab)

type = String(default='feed)

Face

user = Reference(User)
address = String
domain = String

source = String
foreign_id = String
global_id = String  

screen_name = String
screen_name_lower = String

email = String  
emails = String  

geo = Embed(Geo)
bio = Embed(Bio)
analytics = Embed(Analytics)

communities = List(Int)

followers = Int
friends = Int
posts = Int

activity = Float
hits = Int

synced = Int


first_name = String(length=max_name)
middle_name = String(length=max_name)
last_name = String(length=max_name)
name = String(length=max_name)
name_prefix = String(length=max_name)
name_suffix = String(length=max_name)
title = String(length=max_name)
description = String

Content

private = Boolean

face = Reference(Face)
subject = String
text = String
more = String
about = String

api = String
source = String
foreign_id = String
global_id = String(unique)

mention_names = List(String)
mention_ids = List(String)

screen_name = String
screen_name_lower = String

communities = List(Int)
media = List(Dict)

networks = List(Reference(Network))

geo = Embed(Geo)
analytics = Embed(Analytics)
language = String

time = Float
hits = Int(default=1)


fed = Int
sent = Int
indexed = Int
archived = Int


seen = Int

React

fact = Reference(Content)
face = Reference(Face)
reaction = String
time = Int

Interact

face = Reference(Face)
interactor = Reference(Face)
interaction = String
period = Int
interval = Int

Rule

user = Reference(User)

source = String
number = Int

group = String
term = String
hits = Int

priority = Int
checked = Float
merged = Float
activity = Float

frequency = Int(default=60)
count = Int(default=200, min_value=1, max_value=200)
backfill = Boolean

newest = String(default='0)
oldest = String(default='0)
auth = Reference(Auth)

Match

grab = Reference(Grab)
item = Reference

global_id = String
source = String
screen_name_lower = String
record_type = String

mode = String
processed = Float

analytics = Embed(Analytics)

time = Int
pinned = Int
fed = Int
fed_message = Reference(Message)
indexed = Int

Person

grab = Reference(Grab)
user = Reference(User)
global_id = String
screen_name_lower = String

mode = String
processed = Float

analytics = Embed(Analytics)

time = Int
indexed = Int

Geocode

user = Reference(User)

location = String(unique)
latitude = Float
longitude = Float
country = String
countrycode = String
area = String
subarea = String
locality = String
north = Float
south = Float
east = Float
west = Float

Revision

user = Reference(User)
time = Int
text = String

Geo

location = String(length=max_name)
latitude = Float
longitude = Float
point = GeoPoint

city = String(length=max_name)
state = String(length=max_name)
country = String(length=max_name)
cc = String(length=2)

Bio

age = Int
avatar = String(length=max_url)
description = String(length=max_desc)
gender = String(length=1)
language = String(length=max_id)
name = String(length=max_name)
screen_name = String(length=max_name)
photo = String(length=max_url)
timezone = String(length=max_id)
tz = Int
url = String(length=max_url)

Style

app_logo = String(length=max_url)
avatar = String(length=max_url)
background = String(length=max_url)
banner = String(length=max_url)
favicon = String(length=max_url)
hero = String(length=max_url)
icon = String(length=max_url)
icon_type = String(length=max_name)
image = String(length=max_name)
photo = String(length=max_url)
photo_sm = String(length=max_url)
photo_md = String(length=max_url)
photo_lg = String(length=max_url)
snapshot = String(length=max_url)
thumbnail = String(length=max_url)

logo = String(length=max_url)
logo_hide = Boolean


link = String(length=32)
text = String(length=32)
page = String(length=32)
hover = String(length=32)
active = String(length=32)
alert = String(length=32)
error = String(length=32)
success = String(length=32)
info = String(length=32)
default = String(length=32)


nav_color = String(length=32)
nav_text = String(length=32)
nav_font = String
nav_fontsize = Int
nav_height = Int

layout = String(default='list')

PageStyle

favicon = String(length=max_url)
title = String


link = String(length=6)
text = String(length=6)
page = String(length=6)
hover = String(length=6)
active = String(length=6)
alert = String(length=6)
error = String(length=6)
success = String(length=6)
info = String(length=6)
default = String(length=6)


nav_color = String(length=6)
nav_text = String(length=6)
nav_font = String
nav_fontsize = Int
nav_height = Int

Media

type = String(length=max_type)
height = Int
width = Int
length = Int
source = String(length=max_url)
thumbnail = String(length=max_url)

Refs

users = Map(List(Reference(User)))
messages = Map(List(Reference(Message)))
contents = Map(List(Reference(Content)))

annotations = Map(Reference(Annotation))
lists = Map(Reference(List))

links = Map(String(length=max_url))
media = List(Embed(Media))

Analytics


score = Float
plus = Float
minus = Float
influence = Float
outreach = Float
rating = Float
ratings = Int


trending = Float
velocity = Float
acceleration = Float
trended = Int


sentiment = Float
subjectivity = Float


interest = Float
bot = Float
spam = Float
boring = Float
profanity = Float
controversy = Float


posts = Int
reposts = Int
likes = Int
comments = Int
shares = Int
replies = Int
mentions = Int


links = Int
photos = Int
videos = Int
tags = Int
symbols = Int


friends = Int
followers = Int
contacts = Int
connections = Int


count = Int
content = Map(Float)
visits = Int

Action

user = Reference(User)
by = Reference(User)
network = Reference(Network)
list = Reference(List)

time = Int
action = String
reason = String

Social

site = String
id = String

Property

name = String
value = String

Updated 3 years ago

Data Definitions


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.