Setup

Gets a tag by the specified ID.

The getTag() function returns a Promise that resolves to a tag whose ID matches the specified ID.

function getTag(tagId: string, options: GetTagOptions): Promise<BlogTag>

Gets a tag by the specified label.

The getTagByLabel() function returns a Promise that resolves to a tag whose label matches the specified label.

function getTagByLabel(label: string, options: GetTagByLabelOptions): Promise<GetTagByLabelResponse>

Gets a tag by the specified slug.

The getTagBySlug() function returns a Promise that resolves to a tag whose slug matches the specified slug.

The slug is the end of a tag's URL that refers to a specific tag. For example, if a tag's URL is https://example.com/blog/tag/{my-tag-slug}, the slug is my-tag-slug. The slug is case-sensitive and derived from the tag's label.

function getTagBySlug(slug: string, options: GetTagBySlugOptions): Promise<GetTagBySlugResponse>

Creates a query to retrieve a list of tags.

The queryTags() function builds a query to retrieve a list of up to 4,000 tags per language, and returns a TagsQueryBuilder 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 TagsQueryBuilder functions onto the query. TagsQueryBuilder functions enable you to sort, filter, and control the results that queryTags() returns.

queryTags() runs with these TagsQueryBuilder defaults that can be overridden:

• limit(50)
• ascending('_id')

The following TagQueryBuilder functions are supported for queryTags(). For a full description of the Tags object, see the object returned for the items property in TagsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),hasSome()
label	eq(),ne(),startsWith(),hasSome(),exists(),in(),ascending(),descending()
slug	eq(),ne(),startsWith(),hasSome(),exists(),in(),ascending(),descending()
publicationCount	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
postCount	eq(),ne(),lt(),le(),gt(),ge(),in(),ascending(),descending()
translationId	eq(),ne(),exists(),in()
language	eq(),ne(),exists(),in(),ascending(),descending()

function queryTags(options: QueryTagsOptions): TagsQueryBuilder