Tags: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Tag object:

FieldSupported FiltersSortable
id$eq, $ne, $hasSome
label$eq, $ne, $contains, $startsWith, $hasSome, $lt, $lte, $gt, $gte, $exists, $inSortable
slug$eq, $ne, $startsWith, $lt, $lte, $gt, $gte, $in,$hasSomeSortable
postCount$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
publishedPostCount$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
translationId$eq, $ne, $exists, $in
language$eq, $ne, $exists, $inSortable

Related content: API Query Language, Query endpoint 1

Was this helpful?
Yes
No

Tag Object

Attributes
idstringRead-onlyformat GUID
Tag ID.

labelstringmaxLength 100
Tag label. A blog can't have two tags with the same label.

slugstringmaxLength 100
Tag slug. For example, 'tag-slug'.

createdDatestringRead-onlyformat date-time
Date the tag was created.

updatedDatestringRead-onlyformat date-time
Date the tag was last updated.

publicationCountintegerRead-onlydeprecated - use published_post_count insteadminimum 0
Reserved for internal use.

postCountintegerRead-onlyminimum 0
Number of posts with this tag, including unpublished draft posts.

urlobject
Tag URL.

publishedPostCountintegerRead-onlyminimum 0
Number of published posts with this tag.

translationIdstringRead-onlyformat GUID
ID of the tag translations. All translations of a single tag share the same translationId.

languagestringformat LANGUAGE
Tag language. 2-letter language code in ISO 639-1 alpha-2 format.
Was this helpful?
Yes
No

PostCreate Tag

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:
Manage Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/v3/tags

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Tag By Label

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:
Read Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/v3/tags/labels/{label=**}

Was this helpful?
Yes
No

GetGet Tag

Gets a tag with the provided ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/v3/tags/{tagId}

Was this helpful?
Yes
No

DeleteDelete Tag

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:
Manage Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
DELETE
https://www.wixapis.com/v3/tags/{tagId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Tag By Slug

Gets a tag with the provided slug.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/v3/tags/slugs/{slug}

Was this helpful?
Yes
No

PostQuery Tags

Developer Preview

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 in DESC order.
  • paging.limit is 50.
  • paging.offset is 0.

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:
Read Blog
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/v3/tags/query

Was this helpful?
Yes
No

Tag Created

Triggered when a tag is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.blog.v3.tag.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.
Was this helpful?
Yes
No

Tag Updated

Triggered when a tag is updated.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.blog.v3.tag.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No

Tag Deleted

Triggered when a tag is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.blog.v3.tag.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.
Was this helpful?
Yes
No