Tags: Supported Filters and Sorting
The following table shows field support for filters and sorting for the Tag object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $hasSome | |
label | $eq , $ne , $contains , $startsWith , $hasSome , $lt , $lte , $gt , $gte , $exists , $in | Sortable |
slug | $eq , $ne , $startsWith , $lt , $lte , $gt , $gte , $in ,$hasSome | Sortable |
postCount | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
publishedPostCount | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
translationId | $eq , $ne , $exists , $in | |
language | $eq , $ne , $exists , $in | Sortable |
Related content: API Query Language, Query endpoint 1
Tag ID.
Tag label.
A blog can't have two tags with the same label.
Tag slug. For example, 'tag-slug'.
Date the tag was created.
Date the tag was last updated.
Reserved for internal use.
Number of posts with this tag, including unpublished draft posts.
Tag URL.
Number of published posts with this tag.
ID of the tag translations.
All translations of a single tag share the same translationId.
Tag language.
2-letter language code in ISO 639-1 alpha-2 format.
Creates a new tag with the provided label if a tag with the same label doesn't already exist.
Permission Scopes
For app development, you must have one of the following permission scopes:Gets a tag by the provided label.
Sub-labels can also be specified using a /
. For example, you can have 'dessert/icecream'
and 'dessert/pie'
as two different tag labels.
Note: The full URL path following labels/
is counted as 1 label. Adding a /
to a label does not create multiple labels. This means that 'dessert/icecream'
is a sinlge label.
Permission Scopes
For app development, you must have one of the following permission scopes:Gets a tag with the provided ID.
Permission Scopes
For app development, you must have one of the following permission scopes:Deletes a tag. Deleting a tag removes that tag from all blog posts that contain it.
Permission Scopes
For app development, you must have one of the following permission scopes:Gets a tag with the provided slug.
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 a list of up to 500 tags, given the provided paging, filtering, and sorting.
Query Posts runs wuth these defaults, which you can override:
postCount
is sorted inDESC
order.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:Triggered when a tag 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.v3.tag.
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 tag 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.v3.tag.
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 tag 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.v3.tag.
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.