Posts: Supported Filters and Sorting
The following table shows field support for filters and sorting for the Post object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $hasSome | Sortable |
title | $eq , $ne , $contains , $startsWith , $endsWith , $hasSome , $lt , $lte , $gt , $gte , $exists , $in | Sortable |
firstPublishedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
lastPublishedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
slug | $hasSome , $hasAll | |
featured | $eq , $ne | Sortable |
pinned | $eq , $ne | Sortable |
categoryIds | $hasSome , $hasAll | |
memberId | $eq , $ne , $hasSome | |
hashtags | $hasSome , $hasAll | |
commentingEnabled | $eq , $ne | Sortable |
minutesToRead | $eq , $ne , $lt , $lte , $gt , $gte , $in | |
tagIds | $hasSome , $hasAll | |
pricingPlanIds | $hasSome , $hasAll | |
language | $eq , $ne , $hasSome , $exists , $in | |
translationId | $eq , $ne , $exists , $in | |
metrics.views | $eq , $ne , $gt , $lt , $gte , $lte , $in | Sortable |
metrics.comments | $eq , $ne , $gt , $lt , $gte , $lte , $in | Sortable |
metrics.likes | $eq , $ne , $gt , $lt , $gte , $lte , $in | Sortable |
Related content: API Query Language, Query Posts
Post ID.
Post title.
Post excerpt. Can be selected by a site contributor. By default, it is extracted from the content text's first characters.
Max: 140 characters
The post's content in plain text.
Date the post was first published.
Date the post was last published.
Post URL.
Post slug. For example, 'post-slug'.
Whether the post is marked as featured.
Whether the post is pinned. If true, the post is placed at the top of the post list.
Category IDs of the post.
Deprecated. Use media instead. This property will be removed on June 30, 2023.
Post cover media.
Post owner's member ID.
Hashtags in the post.
Whether commenting on the post is enabled.
Estimated reading time (calculated automatically).
Image placed at the top of the blog page.
IDs of tags the post is tagged with.
IDs of posts related to the post.
Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.
ID of the translations of this post. All translations of a single post share the same translationId.
Language the post is written in.
2-letter language code in ISO 639-1 alpha-2 format.
SEO data.
Reserved for internal use.
Post owner's contact ID.
Post rich content
Whether the returned content is a preview of premium content. Defaults to false. A preview displays a limited number of paragraphs of paid content to non-subscribed users.
Reserved for internal use.
Reserved for internal use.
Post moderation details. Only relevant to posts submitted by guest writers.
Post cover media.
Post rich content as a string
Indicates if there is a draft post with changes that have not yet been published.
Reserved for internal use.
Reserved for internal use.
Reserved for internal use.
Gets a post by the specified ID.
Permission Scopes
For app development, you must have one of the following permission scopes:Gets a post with the provided slug.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a list of up to 100 published posts per request.
List Posts runs with these defaults, which you can override:
firstPublishedDate
is sorted in descending order, with pinned posts first.paging.limit
is50
.paging.offset
is0
.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
Query Posts runs with these defaults, which you can override:
firstPublishedDate
is sorted in descending order, with pinned posts first.paging.limit
is50
.paging.offset
is0
.
For field support for filters and sorting, see Field Support for Filtering and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection. For a detailed list of supported filters and sortable fields, see Field Support for Filtering and Sorting.
Permission Scopes
For app development, you must have one of the following permission scopes:Gets a specified post's metrics.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves the number of published posts per month within a specified time range.
The time range is set using the rangeStart
and months
properties.
The time range always starts on the 1st day of the month set in rangeStart
and
includes the number of months
following rangeStart
.
For example, if rangeStart
is set to '2022-03-13'
and months
is set to 4
,
the time range will be from '2022-03-01'
until '2022-06-30'
. The time range always ends on the last day of the month.
Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has 0
posts dated in February 2022. If rangeStart
is set to '2022-01-01'
and months
is set to 3
, the response includes postCount
values for January and March, but not February.
Permission Scopes
For app development, you must have one of the following permission scopes:This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Gets the total amount of published posts of the blog.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a post is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.blog.post.
Event name. Expected created.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
Triggered when a post is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.blog.post.
Event name. Expected updated.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
Triggered when a post is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.blog.post.
Event name. Expected deleted.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
Triggered when a post is liked.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.blog.post.
Event name. Expected liked.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
Triggered when a post is unliked.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.blog.post.
Event name. Expected unliked.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.