> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetTagByLabel # Package: blog # Namespace: TagService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/blog/tags/get-tag-by-label.md ## Permission Scopes: Read Blog : SCOPE.DC-BLOG.READ-BLOGS ## Introduction Retrieves a tag by the provided label. Sub-labels can also be specified using a `/`. For example, you can have `'dessert/icecream'` and `'dessert/pie'` as two different tag labels. > **Note:** The full URL path following `labels/` is counted as 1 label. Adding a `/` to a label does _not_ create multiple labels. This means that `'dessert/icecream'` is a single label. --- ## REST API ### Schema ``` Method: getTagByLabel Description: Retrieves a tag by the provided label. Sub-labels can also be specified using a `/`. For example, you can have `'dessert/icecream'` and `'dessert/pie'` as two different tag labels. > **Note:** The full URL path following `labels/` is counted as 1 label. Adding a `/` to a label does _not_ create multiple labels. This means that `'dessert/icecream'` is a single label. URL: https://www.wixapis.com/v3/tags/labels/{label=**} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: label Method parameters: query param name: fieldsets | type: array | description: List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default only the tag's base fields are returned. - enum: UNKNOWN, URL query param name: label | type: label | description: Tag label. | required: true query param name: language | type: language | description: Tag language. 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If omitted, tags in all languages are returned. Return type: GetTagByLabelResponse - name: tag | type: Tag | description: Retrieved tag. - name: id | type: string | description: Tag GUID. - name: label | type: string | description: Tag label. A blog can't have two tags with the same label. - name: slug | type: string | description: Part of a tag's URL that refers to a specific tag. For example, `'https:/example.com/tags/{my-tag-slug}'` - name: createdDate | type: string | description: Date the tag was created. - name: updatedDate | type: string | description: Date the tag was last updated. - name: url | type: PageUrl | description: Tag URL. The `url` directs you to a page that lists every post with the specified tag. - name: base | type: string | 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`. - name: path | type: string | description: The relative path for the page within the site. For example, `/product-page/a-product`. - name: publishedPostCount | type: integer | description: Number of published posts with this tag. - name: translationId | type: string | description: GUID of the tag's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single tag share the same `translationId`. - name: language | type: string | description: Tag language. 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. ``` ### Examples ### GetTagByLabel ```curl ~~~cURL curl \ 'https://www.wixapis.com/blog/v3/tags/labels/vacation' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.blog.TagService.getTagByLabel(label, options) Description: Retrieves a tag by the provided label. Sub-labels can also be specified using a `/`. For example, you can have `'dessert/icecream'` and `'dessert/pie'` as two different tag labels. > **Note:** The full URL path following `labels/` is counted as 1 label. Adding a `/` to a label does _not_ create multiple labels. This means that `'dessert/icecream'` is a single label. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: label Method parameters: param name: label | type: string | description: Tag label. | required: true param name: options | type: GetTagByLabelOptions none - name: language | type: string | description: Tag language. 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If omitted, tags in all languages are returned. - name: fieldsets | type: array | description: List of additional tag fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in the response in addition to the tag's base fields. Base fields don’t include any of the supported fieldset values. By default only the tag's base fields are returned. - enum: UNKNOWN, URL Return type: PROMISE - name: tag | type: Tag | description: Retrieved tag. - name: _id | type: string | description: Tag GUID. - name: label | type: string | description: Tag label. A blog can't have two tags with the same label. - name: slug | type: string | description: Part of a tag's URL that refers to a specific tag. For example, `'https:/example.com/tags/{my-tag-slug}'` - name: _createdDate | type: Date | description: Date the tag was created. - name: _updatedDate | type: Date | description: Date the tag was last updated. - name: url | type: string | description: Tag URL. The `url` directs you to a page that lists every post with the specified tag. - name: publishedPostCount | type: integer | description: Number of published posts with this tag. - name: translationId | type: string | description: GUID of the tag's translations when [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-translating-your-blog) is installed on a site. All translations of a single tag share the same `translationId`. - name: language | type: string | description: Tag language. 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. ``` ### Examples ### Get a tag by its label with additional fields ```javascript import { tags } from '@wix/blog'; /* Sample label value: * 'my tag' * Sample options value: * { * fieldsets: * [ * 'URL' * ] * } */ export async function getTagByLabelFunction(tagId, options) { try { const result = await tags.getTagByLabel(tagId, options); const label = result.tag.label; const postCount = result.tag.postCount; const url = result.tag.url; console.log('Retrieved result:', result); return result; } catch (error) { console.error(error); } } /* Promise resolves to: * { * "tag": { * "_createdDate": "2022-07-19T10:30:03.607Z", * "_id": "32970480-e53b-46e7-b52f-fba810a0b45d", * "label": "my tag", * "slug": "my-tag", * "_updatedDate": "2022-07-19T10:30:03.607Z", * "postCount": 1, * "publishedPostCount": 1, * "language": "en", * "translationId": "", * "url": "http://https://tadasz7.wixsite.com/blog-velo-events/my-blog/tags/my-tag" * } * } */ ``` ### Get a tag by its label ```javascript import { tags } from '@wix/blog'; /* Sample label value: * 'my tag' */ export async function getTagByLabelFunction(tagId) { try { const result = await tags.getTagByLabel(tagId); const label = result.tag.label; const postCount = result.tag.postCount; console.log('Retrieved result:', result); return result; } catch (error) { console.error(error); }; } /* Promise resolves to: * { * "tag": { * "_createdDate": "2022-07-19T10:30:03.607Z", * "_id": "32970480-e53b-46e7-b52f-fba810a0b45d", * "_updatedDate": "2022-07-19T10:30:03.607Z", * "label": "my tag", * "language": "en", * "postCount": 1, * "publishedPostCount": 1, * "slug": "my-tag", * "translationId": "" * } * } */ ``` ### getTagByLabel (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { tags } from '@wix/blog'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { tags }, // Include the auth strategy and host as relevant }); async function getTagByLabel(label,options) { const response = await myWixClient.tags.getTagByLabel(label,options); }; ``` ---