Every blog record belongs to one site. This page lists the fields of each record: the label on the admin form, the stored name used by the JSON:API, its limits, and notes. A field marked not on the form is set by the API or by the blog itself. Titles, names and descriptions are plain text, and any tags typed into them are removed when the record is saved.
Post
Form label
Stored name
Type and limits
Notes
Title
title
Text, 1 to 500 characters
Required.
Subtitle
subtitle
Text, up to 300 characters
A line under the title.
Slug
slug
Text, 1 to 255 characters
Required. Unique on the site. Follows the title while you add a post.
Content
content
HTML
Required. Cleaned on save, with code blocks highlighted.
Excerpt
excerpt
Text, up to 1000 characters
The summary shown in lists and used as the description.
Featured Image
featured_image_url
Text, up to 500 characters
An address. The form can fill it from the media library.
Status
status
draft, published, scheduled or archived
Default draft. The form offers Draft, Published and Scheduled. Deleting a post sets archived.
Not on the form
published_at
Date and time
Set to now when a post is published without one. A published post must have it.
Not on the form
scheduled_publish_at
Date and time
Required for a scheduled post, and must be in the future. Set it with the schedule route.
Featured
featured
Yes or no
Default no.
Language
language
A language code, up to 10 characters
Required. Default en.
Language Group
language_group_id
An id
Links the editions of one post. Only posts of the same site are offered. Left on the default, a new post starts its own group.
Site
site_id
An id
Shown to masters when adding. A site admin's posts take the admin's site.
Collections, Bloggers / Authors, Tags
collection_ids, blogger_ids, tag_ids
Lists of ids
Replace the post's current list when saved. Only records of the post's own site are accepted.
SEO Tags
seo_tags
A list of tag, attrs and content
tag is title, meta or link. attrs is required. Default empty.
Schema (JSON)
schema
A list of objects
Structured data. Default empty.
Permissions
permissions
A list of permission names
Empty means everyone may open the post. Names are trimmed and lower-cased.
Share image
None
Display only
On the edit form only. Shows the share image and Regenerate.
Not on the form
reading_time_minutes
Whole number
Worked out on save at 200 words a minute, never under 1.
A site cannot hold two posts with the same slug, or two posts in the same language and language group. A post also carries the counts view_count, approved_comment_count, collection_count, tag_count, blogger_count, bookmark_count and rating_count, and the average rating_average. Only holders of the post area can read comment_count, which counts comments in every status, and version_count.
Collection
Form label
Stored name
Type and limits
Notes
Name
name
Text, 1 to 255 characters
Required.
Slug
slug
Text, 1 to 255 characters
Required. Unique on the site.
Status
status
active, draft or archived
Default draft. Only active collections are public.
Language
language
A language code, up to 10 characters
Required. Default en.
Language Group
language_group_id
An id
Links the editions of one collection.
Parent Collection
parent_collection_id
An id
Nests the collection. It must be on the same site and cannot be the collection itself.
Display Order
display_order
Whole number, 0 or more
Default 0. Category lists sort by it, then by name.
Featured
featured
Yes or no
Default no.
Description
description
Text, up to 2000 characters
SEO Tags, Schema (JSON), Permissions
seo_tags, schema, permissions
Lists
As on a post.
Tag
Form label
Stored name
Type and limits
Notes
Name
name
Text, 1 to 255 characters
Required.
Slug
slug
Text, 1 to 255 characters
Required. Unique on the site.
Language
language
A language code, up to 10 characters
Required. Default en.
Language Group
language_group_id
An id
Links the editions of one tag.
Parent Tag
parent_tag_id
An id
Nests the tag.
Description
description
Text
SEO Tags, Permissions
seo_tags, permissions
Lists
As on a post. A tag has no status and no structured data field.
Blogger
Form label
Stored name
Type and limits
Notes
User
user_id
An id
Required, and set when adding. One profile for each account on a site.
Display Name
display_name
Text, 1 to 255 characters
Required.
Slug
slug
Text, 1 to 255 characters
Required. Unique on the site. Follows the display name while you add a profile.
Contact Email
contact_email
Text, up to 255 characters
Lower-cased.
Can Publish Directly
can_publish_directly
Yes or no
Default no. Admin-only field.
Teams
team_ids
A list of ids
The teams the blogger belongs to.
Bio
bio
Basic HTML
Avatar, Cover Image
avatar_url, cover_image_url
Text, up to 500 characters each
Addresses. The form fills them from the media library.
Expertise Areas
expertise_areas
A list of text
Empty entries and repeats are dropped.
Social Links
social_links
A list of platform and url
Both parts are required. An X or Twitter link supplies twitter:creator on the blogger's posts.
Team
Form label
Stored name
Type and limits
Notes
Name
name
Text, 1 to 255 characters
Required.
Slug
slug
Text, 1 to 255 characters
Required. Unique on the site.
Status
status
active, inactive or draft
Required. Default draft. Only active teams are public.
Description
description
Text
Avatar, Cover Image
avatar_url, cover_image_url
Text, up to 500 characters each
Addresses.
Not on the form
member_ids, permission_ids
Lists of ids
Set members and attached permissions over the API. Members are bloggers.
Comment
Form label
Stored name
Type and limits
Notes
Post
post_id
An id
Required, and set when adding.
Author
author_id
An id
Shown to masters when adding. A comment written by a signed-in user takes that user.
Content
content
Text
Required.
Status
status
pending, approved, flagged or spam
Default pending. Only approved comments are public.
Pinned
is_pinned
Yes or no
Default no.
Parent Comment
parent_comment_id
An id
Makes the comment a reply. It must be on the same post and cannot be the comment itself.
Not on the form
sender_data
The sender's ip_address and user_agent
Visible to moderators only.
Auto posting configuration
Stored name
Type and limits
Notes
name
Text, 1 to 255 characters
Required.
plugin
Text, 1 to 255 characters
Required. One configuration for each plugin on a site.
description
Text
is_active
Yes or no
Default no. The Activate and Deactivate actions set it.
config
A map
Settings the plugin defines for itself. Default empty.
Reader records
Record
Fields
Rule
Rating
rating
A whole number from 1 to 5. One for each reader and post. Sending another replaces it.
Bookmark
post_id
One for each reader and post.
Comment vote
vote_type
up or down. One for each reader and comment. Voting again replaces it.
Blogger follow, team follow
notification_enabled, followed_at
One for each reader and blogger or team. notification_enabled defaults to yes.
Post view
ip_address, user_agent, referer
One for each signed-in reader and post, or for each address and post when the reader is a guest. ip_address is up to 45 characters, the others up to 500.
Shared behavior
Deleting archives. Archived posts, collections, tags, bloggers, teams, comments and configurations can be restored. An archived record cannot be edited.
Posts, collections, tags, bloggers, teams and configurations keep a version history. Comments do not.
Posts, collections and tags have editions in several languages. Bloggers and teams do not.