Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Gets the page's SEO-related link tags.

Use the `links` property to get a page's SEO-related link tags which provide additional
 SEO information about your page. For example, the tags may contain a link to a canonical
 or alternate version of the current page.

> **Note:**
 You should always invoke the `wixSeoFrontend.links` getter outside of the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to
 ensure receiving the proper response.

```javascript
import { seo } from "@wix/site-seo";

const wixClient = createClient({ host: site.host(), modules: { seo } });

let links = await wixClient.seo.links();

/* links:
 *
 * [
 *   {
 *     "rel": "canonical", 
 *     "href": "http://mysite.com/canonical_version"
 *   }, {
 *     "rel": "author",  
 *     "href": "http://mysite.com/janedoe"
 *   }
 * ]
 */
```

Get a page's link tags

links

```javascript
import { seo } from "@wix/site-seo";
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";

const wixClient = createClient({ host: site.host(), modules: { seo } });

let metaTags = await wixClient.seo.metaTags();

/* metaTags:
 *
 * [
 *   {
 *     "name": "robots",
 *     "content": "noindex"
 *   }, {
 *     "property": "og:image",
 *     "content": "wix:image://v1/6...2.jpg/a.jpg#originWidth=970&originHeight=120"
 *   }
 * ]
 */
```

Get a page's meta tags

metaTags

MetaTag

Sets the page's SEO-related link tags.

Use the `setLinks()` function to set a page's SEO-related link tags which provide additional
 SEO information about your page. For example, you can set a link to a canonical
 or alternate version of the current page.

 The links you set overwrite any link information set earlier.

> **Notes:**
> * You should always set the links inside the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to ensure search engines can read it.
>
> * You cannot add a stylesheet link using the `setLinks` function.

```javascript
import { seo } from "@wix/site-seo";
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";

const wixClient = createClient({ host: site.host(), modules: { seo } });

document.addEventListener('DOMContentLoaded', async () => {
  try {
    await wixClient.seo.setLinks(
      [
        {
          "rel": "canonical", 
          "href": "http://mysite.com/cononical_version"
        }, {
          "rel": "author", 
          "href": "http://mysite.com/janedoe"
        }
      ]
    );
    console.log("links set");
  } catch {
    console.log("failed setting links");
  }
});
```

setLinks

void

Sets the page's SEO-related meta tags.

The `setMetaTags()` function creates SEO-related meta tags in the head of the page.

 The keys in the specified `metaTags` objects represent the keys in the tag, while the values in the
 `metaTags` object represent the values in the tag.

 For example:

 ```javascript
 {
   "property": "og:image",
   "content": "https://.../Wix+logo.jpg"
 }
 ```

Produces:

 ```html

 ```

 When setting `og:image` meta tags, the `content` can be and external image URL
 or a Media Manager image URL as described [here](https://dev.wix.com/docs/velo/api-reference/$w/image/src).

 The meta tags you set overwrite any meta tag information set earlier.
> **Notes:**
> * Do not use `setMetaTags()` to create tags for the title. Use the [`setTitle()`](#setTitle) function instead.
>
> * You should always set the `metaTags` inside the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to ensure search engines can read it.

```javascript
import { seo } from "@wix/site-seo";

const wixClient = createClient({ host: site.host(), modules: { seo } });

document.addEventListener("DOMContentLoaded", async () => {
  try {
    await wixClient.seo.setMetaTags(
      [
        {
          "name": "robots",
          "content": "noindex"
        }, {
          "property": "og:image",
          "content": "wix:image://v1/6...2.jpg/a.jpg#originWidth=970&originHeight=120"
        }
      ]
    );
    console.log("meta tags set");
  } catch {
    console.log("failed setting meta tags");
  }
});
```

Set a page's meta tags

setMetaTags

List of structured data objects in the JSON-LD format as defined by [schema.org](https://schema.org/docs/schemas.html).

structuredData

Sets the page's structured data.

The structured data on your page helps search engines understand more about
 your page and your business so they can display a richer snippet of your pages
 in search results.

 The structured data you set overwrites any structured data information set earlier.

 > **Note:**
  You should always set the structured data inside the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to
  ensure search engines can read it.

```javascript
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";
import { seo } from "@wix/site-seo";

const wixClient = createClient({
  host: site.host(),
  modules: { seo }
});

// ...

document.addEventListener("DOMContentLoaded", async () => {
  try {
    await wixClient.seo.setStructuredData(
      [
        {
          "@context": "http://schema.org",
          "@type": "Organization",
          "name": "My Organization Name",
          "url": "https://www.myorgdomain.com"
        },
        {
          "@context": "http://schema.org",
          "@type": "Person",
          "email": "mailto:john.doe@somedomain.com",
          "jobTitle": "Professor",
          "name": "John Doe",
          "telephone": "(555) 555-555"
        }
      ]
    );
    console.log("structured data set");
  } catch {
    console.log("failed setting structured data");
  }
});
```

Set a page's structured data

setStructuredData

Fulfilled - When the structured data is set.

title

string

Sets the page's title.

Setting a proper `title` is important to let search engines determine the topic of your page.
> **Note:**
 You should always set the title inside the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to
 ensure search engines can read it.

```javascript
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";
import { seo } from "@wix/site-seo";

const wixClient = createClient({
  host: site.host(),
  modules: { seo }
});

// ...

document.addEventListener("DOMContentLoaded", async () => {
  try {
    await wixClient.seo.setTitle("New Title");
    console.log("title set");
  } catch {
    console.log("failed setting title");
  }
});
```

Set a page's SEO title

setTitle

Gets the page's structured data.

The structured data on your page helps search engines understand more about
 your page and your business so they can display a richer snippet of your pages
 in search results.

 Set the structured data with a list of structured data objects in the JSON-LD format
 as defined by [schema.org](https://schema.org/docs/schemas.html).
> **Note:**
 You should always invoke the `wixSeoFrontend.structuredData` getter outside of the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to
 ensure receiving the proper response.

```javascript
import { seo } from "@wix/site-seo";
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";

const wixClient = createClient({
  host: site.host(),
  modules: { seo }
});

// ...

let structuredData = await wixClient.seo.structuredData();

/* structuredData:
 *
 * [ 
 *   {
 *     "@context": "http://schema.org",
 *     "@type": "Organization",
 *     "name": "My Organization Name",
 *     "url": "https://www.myorgdomain.com"
 *   },
 *   {
 *     "@context": "http://schema.org",
 *     "@type": "Person",
 *     "email": "mailto:john.doe@somedomain.com",
 *     "jobTitle": "Professor",
 *     "name": "John Doe",
 *     "telephone": "(555) 555-555"
 *   }
 * ]
 */
```

Get a page's structured data

object

Gets the page's title.

The `title` is an important factor that lets search engines determine the topic of a page.
> **Note:**
 You should always invoke the `wixSeoFrontend.title` getter outside of the [`onReady()`](https://dev.wix.com/docs/velo/api-reference/$w/on-ready) event handler to
 ensure receiving the proper response.

```javascript
import { seo } from "@wix/site-seo";
import { createClient } from "@wix/sdk";
import { site } from "@wix/site";

const wixClient = createClient({
  host: site.host(),
  modules: { seo }
});

// ...

let title = await wixClient.seo.title(); // "Page Title"
```

Get the SEO title

# Introduction
To use the SEO API, import `wixSeoFrontend` from the `@wix/site-seo` module:

   ```javascript
   import wixSeoFrontend from '@wix/site-seo';
   ```

site-seo

href

The relationship of the linked resource to the current page.

structuredData( )