inner content

{"id":"a4f41fc2-206c-49da-b6c2-28ded184b772","createdDate":"2024-08-29T13:52:16.356Z","updatedDate":"2024-08-29T13:52:16.356Z","resourceId":"fc198052-4e68-46a6-a6da-e0ce4461a206","api":{"schema":{"object":{"displayName":"Tag Object","description":"Blog Submodule Docs","slug":"tag-object","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","legacyExamples":[{"title":"Tag","content":"{\n \"tag\": {\n \"id\": \"33b7a30f-ca8a-4678-84c4-0bab5e3ebf63\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-06-21T08:27:09.764Z\",\n \"updatedDate\": \"2021-06-21T08:27:09.764Z\",\n \"publicationCount\": 3,\n \"postCount\": 10,\n \"language\": \"fr\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"methods":[{"summary":"Create Tag","description":"Creates a new tag with the provided label if a tag with the same label doesn't already exist.","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.CreateTag","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.CreateTagResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTagRequest","description":"","properties":{"label":{"description":"Tag label. The label for each tag in a blog must be unique.","minLength":1,"maxLength":200,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Preferred tag slug. For example, `'tag-slug'`.","maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["label"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Tag Created","description":"Triggered when a tag is created.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.tag_created","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.CREATE-TAG"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.CreateTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.CreateTagResponse"},"legacyExamples":[{"name":"CreateTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/blog/v3/tags/' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"label\": \"vacation\",\n \"language\": \"en\"\n }'\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"0c20a033-bcdb-42af-a793-84a83f4a5bf1\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-09-08T11:11:15.949Z\",\n \"updatedDate\": \"2021-09-08T11:11:15.949Z\",\n \"publicationCount\": 0,\n \"postCount\": 0,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v3/tags","rpcOnly":false,"triggeredEvents":[{"title":"Tag Created","description":"Triggered when a tag is created.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.blog.v3.tag_created","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.CREATE-TAG"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.CreateTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.CreateTagResponse"},"legacyExamples":[{"name":"CreateTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X POST \\\n 'https://www.wixapis.com/blog/v3/tags/' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n -d '{\n \"label\": \"vacation\",\n \"language\": \"en\"\n }'\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"0c20a033-bcdb-42af-a793-84a83f4a5bf1\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-09-08T11:11:15.949Z\",\n \"updatedDate\": \"2021-09-08T11:11:15.949Z\",\n \"publicationCount\": 0,\n \"postCount\": 0,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Create Tag","slugifiedName":"create-tag"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}]},{"summary":"Get Tag By Label","description":"Gets a tag by the provided label.\n\nSub-labels can also be specified using a `/`. For example, you can have `'dessert/icecream'` and `'dessert/pie'` as two different tag labels.\n\n> **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.","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.GetTagByLabel","parameters":[{"name":"label","in":"query","description":"Tag label.","required":true,"schema":{"description":"Tag label.","minLength":1,"maxLength":100,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf omitted, tags in all languages are returned.","required":false,"schema":{"description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf omitted, tags in all languages are returned.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"fieldsToInclude","in":"query","description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","required":false,"schema":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}}},{"name":"fieldsets","in":"query","description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","required":false,"schema":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.GetTagByLabelResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagByLabelRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagByLabelResponse"},"legacyExamples":[{"name":"GetTagByLabel","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/labels/vacation' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/tags/labels/{label=**}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagByLabelRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagByLabelResponse"},"legacyExamples":[{"name":"GetTagByLabel","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/labels/vacation' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Tag By Label","slugifiedName":"get-tag-by-label"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Get Tag","description":"Gets a tag with the provided ID.","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.GetTag","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tagId","description":"Tag ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fieldsToInclude","in":"query","description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","required":false,"schema":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}}},{"name":"fieldsets","in":"query","description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","required":false,"schema":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.GetTagResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagResponse"},"legacyExamples":[{"name":"GetTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/6d72a3bb-053c-4de5-a897-5ef6be30b1b0' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/tags/{tagId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagResponse"},"legacyExamples":[{"name":"GetTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/6d72a3bb-053c-4de5-a897-5ef6be30b1b0' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Tag","slugifiedName":"get-tag"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Delete Tag","description":"Deletes a tag. Deleting a tag removes that tag from all blog posts that contain it.","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.DeleteTag","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"tagId","description":"Tag ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.DeleteTagResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Tag Deleted","description":"Triggered when a tag is deleted.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.blog.v3.tag_deleted","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.DELETE_TAG"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.DeleteTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.DeleteTagResponse"},"legacyExamples":[{"name":"DeleteTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/blog/v3/tags/0c20a033-bcdb-42af-a793-84a83f4a5bf1' \\\n -H 'Authorization: '\n~~~","response":"~~~json\nundefined\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"delete","path":"/v3/tags/{tagId}","rpcOnly":false,"triggeredEvents":[{"title":"Tag Deleted","description":"Triggered when a tag is deleted.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.blog.v3.tag_deleted","sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"}],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.DELETE_TAG"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.DeleteTagRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.DeleteTagResponse"},"legacyExamples":[{"name":"DeleteTag","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl -X DELETE \\\n 'https://www.wixapis.com/blog/v3/tags/0c20a033-bcdb-42af-a793-84a83f4a5bf1' \\\n -H 'Authorization: '\n~~~","response":"~~~json\nundefined\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Delete Tag","slugifiedName":"delete-tag"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"}]},{"summary":"Get Tag By Slug","description":"Gets a tag with the provided slug.","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.GetTagBySlug","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"slug","description":"Slug of the tag to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},{"name":"fieldsToInclude","in":"query","description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","required":false,"schema":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}}},{"name":"fieldsets","in":"query","description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","required":false,"schema":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},{"name":"language","in":"query","description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the tag to retrieve.","required":false,"schema":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the tag to retrieve.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.GetTagBySlugResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagBySlugRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagBySlugResponse"},"legacyExamples":[{"name":"GetTagBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/slugs/vacation' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"get","path":"/v3/tags/slugs/{slug}","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.GetTagBySlugRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.GetTagBySlugResponse"},"legacyExamples":[{"name":"GetTagBySlug","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v3/tags/slugs/vacation' \\\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tag\": {\n \"id\": \"6d72a3bb-053c-4de5-a897-5ef6be30b1b0\",\n \"label\": \"vacation\",\n \"slug\": \"vacation\",\n \"createdDate\": \"2021-08-13T08:58:20.145Z\",\n \"updatedDate\": \"2021-08-13T08:58:20.145Z\",\n \"publicationCount\": 2,\n \"postCount\": 1,\n \"language\": \"en\"\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Get Tag By Slug","slugifiedName":"get-tag-by-slug"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Query Tags","description":"Retrieves a list of up to 500 tags, given the provided paging, filtering, and sorting.\n\nQuery Posts runs wuth these defaults, which you can override:\n- `postCount` is sorted in `DESC` order.\n- `paging.limit` is `50`.\n- `paging.offset` is `0`.\n\nFor field support for filters and sorting, see\n[Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/tags/filter-and-sort).\n\nTo learn about working with _Query_ endpoints, see\n[API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and\n[Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).\nFor a detailed list of supported filters and sortable fields, see\n[Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).","operationId":"com.wixpress.npm.communities.platformized.blog.TagService.QueryTags","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.QueryTagsResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/blog/v3","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3","destinationPath":"/v3","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}},{"url":"https://www.wixapis.com/blog/v3/tags","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/blog/v3/tags","destinationPath":"/v3/tags","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryTagsRequest","description":"","properties":{"filter":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nFilter object.\nFor a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nFilter object.\nFor a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"sort":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nSorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","maxItems":3,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nSorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"paging":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nPagination options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nPagination options.","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"fieldsToInclude":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}},"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.QueryTagsRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.QueryTagsResponse"},"legacyExamples":[{"name":"QueryTags","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v2/tags/query' \\\n --data-binary '{\n \"filter\": {\n \"postCount\": {\n \"$gt\": 5\n }\n }\n }' \\\n }\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tags\": [\n {\n \"id\": \"43b7a30f-ca8a-4678-84c4-0bab5e3ebf63\",\n \"label\": \"books\",\n \"slug\": \"books\",\n \"createdDate\": \"2021-06-21T08:27:09.764Z\",\n \"updatedDate\": \"2021-06-21T08:27:09.764Z\",\n \"publicationCount\": 0,\n \"postCount\": 8,\n \"language\": \"en\"\n }\n ],\n \"metaData\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git"},"httpMethod":"post","path":"/v3/tags/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","errors":[],"exposure":"PUBLIC","maturity":"BETA","permissions":["BLOG.READ_TAG"],"applicableIdentities":["APP","VISITOR"],"externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"protoArtifactId":"com.wixpress.proto:communities-blog-platformized-proto","serviceArtifactId":"com.wixpress.npm.communities-blog-node-api","labels":[{"identifier":"BETA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.npm.communities.platformized.blog.QueryTagsRequest","responseMessage":"com.wixpress.npm.communities.platformized.blog.QueryTagsResponse"},"legacyExamples":[{"name":"QueryTags","type":"METHOD","content":{"title":"","description":"","request":"~~~cURL\ncurl \\\n 'https://www.wixapis.com/blog/v2/tags/query' \\\n --data-binary '{\n \"filter\": {\n \"postCount\": {\n \"$gt\": 5\n }\n }\n }' \\\n }\n -H 'Content-Type: application/json' \\\n -H 'Authorization: '\n~~~","response":"~~~json\n{\n \"tags\": [\n {\n \"id\": \"43b7a30f-ca8a-4678-84c4-0bab5e3ebf63\",\n \"label\": \"books\",\n \"slug\": \"books\",\n \"createdDate\": \"2021-06-21T08:27:09.764Z\",\n \"updatedDate\": \"2021-06-21T08:27:09.764Z\",\n \"publicationCount\": 0,\n \"postCount\": 8,\n \"language\": \"en\"\n }\n ],\n \"metaData\": {\n \"count\": 1,\n \"offset\": 0,\n \"total\": 1\n }\n}\n~~~"}}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","contentLink":{"displayName":"Query Tags","slugifiedName":"query-tags"},"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]}],"webhooks":[{"summary":"Tag Created","title":"Tag Created","description":"Triggered when a tag is created.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.tag_created","legacyExamples":[{"name":"TagCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"a9ae74d5-406d-43f1-9d2c-27033170952d\",\n \"entityFqdn\": \"wix.blog.v3.tag\",\n \"slug\": \"created\",\n \"entityId\": \"c338a90d-8137-4dbc-95c0-5b46ce8b92e2\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"c338a90d-8137-4dbc-95c0-5b46ce8b92e2\",\n \"label\": \"some tag\",\n \"slug\": \"some-tag\",\n \"createdDate\": \"2021-09-07T12:30:38.241Z\",\n \"updatedDate\": \"2021-09-07T12:30:38.241Z\",\n \"publicationCount\": 0,\n \"postCount\": 0,\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/some-site\",\n \"path\": \"/blog/tags/some-tag\"\n },\n \"language\": \"en\"\n }\n },\n \"eventTime\": \"2021-09-07T12:30:38.301Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","contentLink":{"displayName":"Tag Created","slugifiedName":"tag-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Tag Updated","title":"Tag Updated","description":"Triggered when a tag is updated.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.tag_updated","legacyExamples":[{"name":"TagUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"a9ae74d5-406d-43f1-9d2c-27033170952d\",\n \"entityFqdn\": \"wix.blog.v3.tag\",\n \"slug\": \"updated\",\n \"entityId\": \"c338a90d-8137-4dbc-95c0-5b46ce8b92e2\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"c338a90d-8137-4dbc-95c0-5b46ce8b92e2\",\n \"label\": \"some tag\",\n \"slug\": \"some-tag\",\n \"createdDate\": \"2021-09-07T12:30:38.241Z\",\n \"updatedDate\": \"2021-09-07T12:30:38.241Z\",\n \"publicationCount\": 0,\n \"postCount\": 0,\n \"url\": {\n \"base\": \"https://some-user.wixsite.com/some-site\",\n \"path\": \"/blog/tags/some-tag\"\n },\n \"language\": \"en\"\n }\n },\n \"eventTime\": \"2021-09-07T12:30:38.301Z\"\n}"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","contentLink":{"displayName":"Tag Updated","slugifiedName":"tag-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]},{"summary":"Tag Deleted","title":"Tag Deleted","description":"Triggered when a tag is deleted.","permissions":["BLOG.READ_TAG"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.blog.v3.tag","serviceName":"com.wixpress.npm.communities.platformized.blog.TagService","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}],"eventType":"wix.blog.v3.tag_deleted","legacyExamples":[{"name":"TagDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"318b34ba-4047-4f4a-a8b9-1d91a9732fa5\",\n \"entityFqdn\": \"wix.blog.v3.tag\",\n \"slug\": \"deleted\",\n \"entityId\": \"d82102c9-b273-464d-b528-e05c5cdc5df7\",\n \"eventTime\": \"2021-09-07T12:48:31.053Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/npm-proto-bazel.git","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","contentLink":{"displayName":"Tag Deleted","slugifiedName":"tag-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Blog","scopeId":"SCOPE.DC-BLOG.MANAGE-BLOG"},{"name":"Read Blog ","scopeId":"SCOPE.DC-BLOG.READ-BLOGS"},{"name":"Read Draft Blog Posts","scopeId":"SCOPE.DC-BLOG.READ-DRAFT-POSTS"}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Tags API\n\nThe Tags API allows a site visitor to query and list tags to filter through blog posts. Tags are a subset of catagories for organizing blog posts, making it easier for users to navigate and search for specific topics.\n\nYou can assign up to 30 tags per post, and each tag is limited to 50 characters.\n\nWith the Wix Tags API, you can:\n\n- Create and manage tags to allow users to categorize and organize their content.\n- Retrieve tags based on their label or slug to allow users to find and filter content.\n- Query tags to retrieve a list of tags based on specific criteria, providing users with customized tag suggestions or recommendations.\n\n## Terminology\n\n- **Post**: A published article on a blog site. It is also referred to as a publication. A blog can have up to 100K posts.\n- **Draft Post**: An article written by a site owner, blog editor, blog writer, or a guest writer that is not yet published.\n- **Category**: A group of similar and related posts. A post can be assigned to a maximum of 10 categories.\n- **Tag**: A way to further sort and organize blog posts. Tags provide the ability to filter blog posts."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Tags: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the Tag object:\n\n| Field | Supported Filters | Sortable |\n| -------------------- | ------------------------------------------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$hasSome` | |\n| `label` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `slug` | `$eq`, `$ne`, `$startsWith`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`,`$hasSome` | Sortable |\n| `postCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `publishedPostCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `translationId` | `$eq`, `$ne`, `$exists`, `$in` | |\n| `language` | `$eq`, `$ne`, `$exists`, `$in` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query endpoint 1](fallback::https://dev.wix.com/docs/rest/business-solutions/blog/tags/query-tags)\n"}],"components":{"schemas":{"com.wixpress.npm.communities.platformized.blog.Tag":{"type":"object","properties":{"id":{"description":"Tag ID.","readOnly":true,"format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"label":{"description":"Tag label.\n\nA blog can't have two tags with the same label.","maxLength":100,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Tag slug. For example, `'tag-slug'`.","maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date the tag was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date the tag was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publicationCount":{"description":"Reserved for internal use.","readOnly":true,"minimum":0,"title":"publicationCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"replacedBy":"published_post_count","targetRemovalDate":"2024-06-30"}}},"postCount":{"description":"Number of posts with this tag, including unpublished draft posts.","readOnly":true,"minimum":0,"title":"postCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Tag URL.","readOnly":true,"$ref":"#/components/schemas/wix.common.PageUrl","summary":"url","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"publishedPostCount":{"description":"Number of published posts with this tag.","readOnly":true,"minimum":0,"title":"publishedPostCount","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"translationId":{"description":"ID of the tag translations.\n\nAll translations of a single tag share the same `translationId`.","readOnly":true,"format":"GUID","title":"translationId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","immutable":true,"format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.common.PageUrl":{"type":"object","properties":{"base":{"description":"The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`.","title":"base","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"path":{"description":"The relative path for the page within the site. For example, `/product-page/a-product`.","title":"path","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PageUrl","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.advanced.seo.SeoSchema":{"type":"object","properties":{"tags":{"description":"SEO tag information.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"settings":{"description":"SEO general settings.","$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Settings","summary":"settings","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SeoSchema","description":"The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\nThe search engines use this information for ranking purposes, or to display snippets in the search results.\nThis data will override other sources of tags (for example patterns) and will be included in the section of the HTML document, while not being displayed on the page itself."},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"com.wixpress.advanced.seo.SeoSchema.Keyword":{"type":"object","properties":{"term":{"description":"Keyword value.","title":"term","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"isMain":{"description":"Whether the keyword is the main focus keyword.","title":"isMain","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"origin":{"description":"Who added the keyword to the settings","maxLength":1000,"title":"origin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Keyword","description":""},"com.wixpress.advanced.seo.SeoSchema.Tag":{"type":"object","properties":{"type":{"description":"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.","title":"type","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"props":{"description":"A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.\nFor example: `{'name': 'description', 'content': 'the description itself'}`.","title":"props","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"meta":{"description":"SEO tag meta data. For example, `{height: 300, width: 240}`.","title":"meta","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"children":{"description":"SEO tag inner content. For example, ` inner content `.","title":"children","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"custom":{"description":"Whether the tag is a custom tag.","title":"custom","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Whether the tag is disabled.","title":"disabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Tag","description":""},"com.wixpress.advanced.seo.SeoSchema.Settings":{"type":"object","properties":{"preventAutoRedirect":{"description":"Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n\n\nDefault: `false` (Auto Redirect is enabled.)","title":"preventAutoRedirect","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"keywords":{"description":"User-selected keyword terms for a specific page.","maxItems":5,"title":"keywords","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.advanced.seo.SeoSchema.Keyword"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Settings","description":""},"com.wixpress.npm.communities.platformized.blog.InitialTagsCopied":{"type":"object","properties":{"count":{"description":"Number of tags copied.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"InitialTagsCopied","description":""},"com.wixpress.npm.communities.platformized.blog.GetOrCreateTagRequest":{"type":"object","properties":{"label":{"description":"Tag name. Unique per blog.","minLength":1,"maxLength":200,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Tag language.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of tag fields to be included if entities are present in the response.\nBase fieldset, which is default, will return all core tag properties.\nExample: When URL fieldset is selected, returned tag will have a set of base properties and tag url.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateTagRequest","description":""},"com.wixpress.npm.communities.platformized.blog.TagField.Field":{"type":"string","description":"","title":"Field","enum":["UNKNOWN","URL","SEO"]},"com.wixpress.npm.communities.platformized.blog.GetOrCreateTagResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetOrCreateTagResponse","description":""},"com.wixpress.npm.communities.platformized.blog.CreateTagRequest":{"type":"object","properties":{"label":{"description":"Tag label. The label for each tag in a blog must be unique.","minLength":1,"maxLength":200,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"Preferred tag slug. For example, `'tag-slug'`.","maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTagRequest","description":""},"com.wixpress.npm.communities.platformized.blog.CreateTagResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTagResponse","description":""},"com.wixpress.npm.communities.platformized.blog.UpdateTagRequest":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of tag fields to be included if entities are present in the response.\nBase fieldset, which is default, will return all core tag properties.\nExample: When URL fieldset is selected, returned tag will have a set of base properties and tag url.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTagRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"com.wixpress.npm.communities.platformized.blog.UpdateTagResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTagResponse","description":""},"com.wixpress.npm.communities.platformized.blog.BulkCreateTagsRequest":{"type":"object","properties":{"tags":{"description":"Tags to create.","minItems":1,"maxItems":50,"title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"returnFullEntity":{"description":"Whether to return the full created tag entities in the response.","title":"returnFullEntity","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of tag fields to be included if entities are present in the response.\nBase fieldset, which is default, will return all core tag properties.\nExample: When URL fieldset is selected, returned tag will have a set of base properties and tag url.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateTagsRequest","description":""},"com.wixpress.npm.communities.platformized.blog.BulkCreateTagsResponse":{"type":"object","properties":{"results":{"description":"Tags created by bulk action.","title":"results","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.BulkTagResult"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"bulkActionMetadata":{"description":"Bulk action metadata.","$ref":"#/components/schemas/wix.common.BulkActionMetadata","summary":"bulkActionMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkCreateTagsResponse","description":""},"com.wixpress.npm.communities.platformized.blog.BulkTagResult":{"type":"object","properties":{"itemMetadata":{"description":"Bulk actions metadata for tag.","$ref":"#/components/schemas/wix.common.ItemMetadata","summary":"itemMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"item":{"description":"Optional created tag.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"item","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkTagResult","description":""},"wix.common.ItemMetadata":{"type":"object","properties":{"id":{"description":"Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originalIndex":{"description":"Index of the item within the request array. Allows for correlation between request and response items.","title":"originalIndex","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"success":{"description":"Whether the requested action was successful for this item. When `false`, the `error` field is populated.","title":"success","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"error":{"description":"Details about the error in case of failure.","$ref":"#/components/schemas/wix.api.ApplicationError","summary":"error","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ItemMetadata","description":""},"wix.api.ApplicationError":{"type":"object","properties":{"code":{"description":"Error code.","title":"code","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the error.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Data related to the error.","title":"data","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ApplicationError","description":""},"wix.common.BulkActionMetadata":{"type":"object","properties":{"totalSuccesses":{"description":"Number of items that were successfully processed.","title":"totalSuccesses","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"totalFailures":{"description":"Number of items that couldn't be processed.","title":"totalFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"undetailedFailures":{"description":"Number of failures without details because detailed failure threshold was exceeded.","title":"undetailedFailures","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkActionMetadata","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagsCountByLanguageRequest":{"type":"object","properties":{},"title":"GetTagsCountByLanguageRequest","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagsCountByLanguageResponse":{"type":"object","properties":{"tagsLanguageCount":{"description":"The language and it's count.","title":"tagsLanguageCount","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagLanguageCount"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagsCountByLanguageResponse","description":""},"com.wixpress.npm.communities.platformized.blog.TagLanguageCount":{"type":"object","properties":{"languageCode":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.","format":"LANGUAGE_TAG","title":"languageCode","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tagCount":{"description":"The count of tags for the language.","title":"tagCount","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TagLanguageCount","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagByLabelRequest":{"type":"object","properties":{"label":{"description":"Tag label.","minLength":1,"maxLength":100,"title":"label","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"Tag language.\n\n2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nIf omitted, tags in all languages are returned.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsToInclude":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagByLabelRequest","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagByLabelResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagByLabelResponse","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagRequest":{"type":"object","properties":{"tagId":{"description":"Tag ID.","minLength":1,"maxLength":38,"title":"tagId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsToInclude":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagRequest","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagResponse","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagBySlugRequest":{"type":"object","properties":{"slug":{"description":"Slug of the tag to retrieve.","minLength":1,"maxLength":100,"title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsToInclude":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"language":{"description":"2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.\nLanguage of the tag to retrieve.","format":"LANGUAGE_TAG","title":"language","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagBySlugRequest","description":""},"com.wixpress.npm.communities.platformized.blog.GetTagBySlugResponse":{"type":"object","properties":{"tag":{"description":"Tag info.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag","summary":"tag","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTagBySlugResponse","description":""},"com.wixpress.npm.communities.platformized.blog.QueryTagsRequest":{"type":"object","properties":{"filter":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nFilter object.\nFor a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nFilter object.\nFor a detailed list of supported filters, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"sort":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nSorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","maxItems":3,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nSorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"paging":{"description":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nPagination options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `query` instead.\nThis parameter will be removed on June 30, 2023.\n\nPagination options.","replacedBy":"query","targetRemovalDate":"2024-06-30"}}},"fieldsToInclude":{"description":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","maxItems":10,"title":"fieldsToInclude","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `fieldsets` instead.\nThis parameter will be removed on June 30, 2023.\n\nList of tag fields to be included in the response.","replacedBy":"fieldsets","targetRemovalDate":"2024-06-30"}}},"query":{"description":"Query options.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.PlatformQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in\nthe response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default\nonly the tag's base fields are returned.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTagsRequest","description":""},"wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","maxLength":512,"title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"com.wixpress.npm.communities.platformized.upstream.tag.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":500,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"com.wixpress.npm.communities.platformized.blog.TagsFieldSet":{"type":"object","properties":{"includeUrl":{"description":"Includes tag URL when TRUE. Defaults to FALSE.","title":"includeUrl","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TagsFieldSet","description":""},"com.wixpress.npm.communities.platformized.upstream.tag.PlatformQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","maxItems":3,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PlatformQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.PlatformQuery.pagingMethod"}]},"com.wixpress.npm.communities.platformized.upstream.tag.PlatformQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.npm.communities.platformized.upstream.tag.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":100,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","maxLength":2000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"com.wixpress.npm.communities.platformized.blog.QueryTagsResponse":{"type":"object","properties":{"tags":{"description":"List of tags.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaData":{"description":"__Deprecated.__ Use `pagingMetadata` instead.\nThis property will be removed on June 30, 2023.\n\nDetails on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.MetaData","summary":"metaData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{"message":"__Deprecated.__ Use `pagingMetadata` instead.\nThis property will be removed on June 30, 2023.\n\nDetails on the paged set of results returned.","replacedBy":"pagingMetadata","targetRemovalDate":"2024-06-30"}}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTagsResponse","description":""},"com.wixpress.npm.communities.platformized.blog.MetaData":{"type":"object","properties":{"count":{"description":"Number of items returned in this response.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Requested offset.","title":"offset","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query.","title":"total","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.","maxLength":2000,"title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaData","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"com.wixpress.npm.communities.platformized.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","maxLength":2000,"title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","maxLength":2000,"title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"com.wixpress.npm.communities.platformized.blog.ListTagsRequest":{"type":"object","properties":{"sort":{"description":"Sorting options. For a list of sortable fields, see [Field Support for Filtering and Sorting](https://dev.wix.com/api/rest/community/blog/filter-and-sort).","maxItems":3,"title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"List of tag fields to be included if entities are present in the response.\nBase fieldset, which is default, will return all core tag properties.\nExample: When URL fieldset is selected, returned tag will have a set of base properties and tag url.","maxItems":10,"title":"fieldsets","type":"array","enum":true,"items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.TagField.Field"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTagsRequest","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.ListTagsRequest.pagingMethod"}]},"com.wixpress.npm.communities.platformized.blog.ListTagsRequest.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `sort`.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.upstream.tag.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.npm.communities.platformized.blog.ListTagsResponse":{"type":"object","properties":{"tags":{"description":"List of tags.","title":"tags","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.Tag"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaData":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/com.wixpress.npm.communities.platformized.blog.MetaData","summary":"metaData","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListTagsResponse","description":""},"com.wixpress.npm.communities.platformized.blog.BulkDeleteTagRequest":{"type":"object","properties":{"tagIds":{"description":"Tag IDs.","minItems":1,"maxItems":100,"maxLength":38,"title":"tagIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkDeleteTagRequest","description":""},"com.wixpress.npm.communities.platformized.blog.BulkDeleteTagResponse":{"type":"object","properties":{},"title":"BulkDeleteTagResponse","description":""},"com.wixpress.npm.communities.platformized.blog.DeleteTagRequest":{"type":"object","properties":{"tagId":{"description":"Tag ID.","maxLength":38,"title":"tagId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteTagRequest","description":""},"com.wixpress.npm.communities.platformized.blog.DeleteTagResponse":{"type":"object","properties":{},"title":"DeleteTagResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Tag","description":"Blog Submodule Docs","fqdn":"wix.blog.v3.tag"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Tags API\n\nThe Tags API allows a site visitor to query and list tags to filter through blog posts. Tags are a subset of catagories for organizing blog posts, making it easier for users to navigate and search for specific topics.\n\nYou can assign up to 30 tags per post, and each tag is limited to 50 characters.\n\nWith the Wix Tags API, you can:\n\n- Create and manage tags to allow users to categorize and organize their content.\n- Retrieve tags based on their label or slug to allow users to find and filter content.\n- Query tags to retrieve a list of tags based on specific criteria, providing users with customized tag suggestions or recommendations.\n\n## Terminology\n\n- **Post**: A published article on a blog site. It is also referred to as a publication. A blog can have up to 100K posts.\n- **Draft Post**: An article written by a site owner, blog editor, blog writer, or a guest writer that is not yet published.\n- **Category**: A group of similar and related posts. A post can be assigned to a maximum of 10 categories.\n- **Tag**: A way to further sort and organize blog posts. Tags provide the ability to filter blog posts."},{"displayName":"Filter and Sort","slugifyName":"filter-and-sort","content":"# Tags: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the Tag object:\n\n| Field | Supported Filters | Sortable |\n| -------------------- | ------------------------------------------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$hasSome` | |\n| `label` | `$eq`, `$ne`, `$contains`, `$startsWith`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte`, `$exists`, `$in` | Sortable |\n| `slug` | `$eq`, `$ne`, `$startsWith`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`,`$hasSome` | Sortable |\n| `postCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `publishedPostCount` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in` | Sortable |\n| `translationId` | `$eq`, `$ne`, `$exists`, `$in` | |\n| `language` | `$eq`, `$ne`, `$exists`, `$in` | Sortable |\n\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query endpoint 1](fallback::https://dev.wix.com/docs/rest/business-solutions/blog/tags/query-tags)\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Create Tag

Permission Scopes