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.
Note:
You should always invoke the wixSeoFrontend.structuredData
getter outside of the onReady()
event handler to
ensure receiving the proper response.
function structuredData(): Promise<Array<object>>;
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"
* }
* ]
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.