POST

Query 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.

Permissions
Manage Blog
Read Blog
Read Draft Blog Posts
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/blog/v3/tags/query

Body Params
filterstructdeprecated - use query instead

Deprecated. Use query instead. This parameter will be removed on June 30, 2023.

Filter object. For a detailed list of supported filters, see Field Support for Filtering and Sorting.


sortArray <Sorting>deprecated - use query insteadmaxItems 3

Deprecated. Use query instead. This parameter will be removed on June 30, 2023.

Sorting options. For a list of sortable fields, see Field Support for Filtering and Sorting.


pagingPagingdeprecated - use query instead

Deprecated. Use query instead. This parameter will be removed on June 30, 2023.

Pagination options.


fieldsToIncludeArray <string>deprecated - use fieldsets insteadmaxItems 10

Deprecated. Use fieldsets instead. This parameter will be removed on June 30, 2023.

List of tag fields to be included in the response.


queryQuery

Query options.


fieldsetsArray <string>maxItems 10

List of additional tag fields to include in the response. For example, use the URL fieldset to retrieve the url field in the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default only the tag's base fields are returned.

Response Object
tagsArray <Tag>

List of tags.


metaDataMetaDatadeprecated - use pagingMetadata instead

Deprecated. Use pagingMetadata instead. This property will be removed on June 30, 2023.

Details on the paged set of results returned.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

Query Tags Example 1
Request
cURL
curl \ 'https://www.wixapis.com/blog/v2/tags/query' \ --data-binary '{ "filter": { "postCount": { "$gt": 5 } } }' \ } -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "tags": [ { "id": "43b7a30f-ca8a-4678-84c4-0bab5e3ebf63", "label": "books", "slug": "books", "createdDate": "2021-06-21T08:27:09.764Z", "updatedDate": "2021-06-21T08:27:09.764Z", "publicationCount": 0, "postCount": 8, "language": "en" } ], "metaData": { "count": 1, "offset": 0, "total": 1 } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?