Setup

Gets a post by the specified ID.

The getPost() function returns a Promise that resolves to a post whose ID matches the given ID.

function getPost(postId: string, options: GetPostOptions): Promise<GetPostResponse>

Gets a post by the provided slug.

The getPostBySlug() function returns a Promise that resolves to a post whose slug matches the given slug.

The slug is the end of a post's URL that refers to a specific post. For example, if a post's URL is https:/example.com/blog/post/my-post-slug, the slug is my-post-slug. The slug is case-sensitive, and is generally derived from the post title, unless specified otherwise.

function getPostBySlug(slug: string, options: GetPostBySlugOptions): Promise<GetPostBySlugResponse>

Gets a specified post's metrics.

The getPostMetrics() function returns a Promise that resolves to the specified post's metrics.

A post's metrics include the comments, likes, and views the post receives.

function getPostMetrics(postId: string): Promise<GetPostMetricsResponse>

Gets the total amount of published posts on the blog.

The getTotalPosts() function returns a Promise that resolves to the total amount of published posts on your blog's site.

You can use the language option to filter posts for a specified language.

function getTotalPosts(options: GetTotalPostsOptions): Promise<GetTotalPostsResponse>

Retrieves a list of published posts.

The listPosts() function returns a Promise that resolves to a list of up to 100 published posts.

Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.

By default, the list is sorted by firstPublishedDate in descending order, and the amount of posts returned is 50.

function listPosts(options: ListPostsOptions): Promise<ListPostsResponse>

Retrieves the number of published posts per month within a specified time range.

The queryPostCountStats() function returns a Promise that resolves to the number of posts per month within the specified time range.

You can set the time range 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 ends on the last day of the month.

function queryPostCountStats(options: QueryPostCountStatsOptions): Promise<QueryPostCountStatsResponse>

Creates a query to retrieve a list of posts.

The queryPosts() function builds a query to retrieve a list of up to 100 posts, and returns a PostsQueryBuilder object.

The returned object contains the query definition which is typically used to run the query using the find() function.

You can refine the query by chaining PostsQueryBuilder functions onto the query. PostsQueryBuilder functions enable you to sort, filter, and control the results that queryPosts() returns.

queryPosts() runs with these PostsQueryBuilder defaults that can be overridden:

• limit(50)
• descending('firstPublishedDate')

Note that the default limit is '50', but the max limit is '100'.

To learn how to query posts, refer to the table below.

The following PostsQueryBuilder functions are supported for the queryPosts() function. For a full description of the Posts object, see the object returned for the items property in PostsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),hasSome(),ascending(),descending()
title	eq(),ne(),startsWith(),hasSome(),exists(),in(),ascending(),descending()
firstPublishedDate	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
lastPublishedDate	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
slug	eq(),ne(),hasSome(),ascending(),descending()
featured	eq(),ne(),ascending(),descending()
pinned	eq(),ne(),ascending(),descending()
categoryIds	hasSome(),hasAll()
coverMedia.enabled	eq(),ne()
memberId	eq(),ne(),hasSome()
hashtags	hasSome(),hasAll()
commentingEnabled	eq(),ne(),ascending(),descending()
minutesToRead	eq(),ne(),lt(),le(),gt(),ge(),in()
tagIds	hasSome(),hasAll()
pricingPlanIds	hasSome(),hasAll()
translationId	eq(),ne(),exists(),in()
language	eq(),ne(),hasSome(),exists(),in()
metrics.comments	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
metrics.likes	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
metrics.views	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()

function queryPosts(options: QueryPostsOptions): PostsQueryBuilder