# SEO Metadata Request


# Description

Using this type of request returns the SEO metadata relating to the parameters set up for it in the SEO metadata config. The SEO metadata refers to what is shown to the user on the site that isn't part of an ad and is instead there to make the website more descriptive but to also increase its level in the search engine rankings by simulating that the website is not entirely automated and bot run by providing meaningful titles, H1 and metadata for the internet search engines such as Google.

# Benefits of SEO Metadata Request

SEO is used in order to increase the rankings of your website on other search engines like Google, the more user-run your website looks, the higher up it gets. Search engines like Google also need a more user-friendly URL for them to see, that is another thing that the SEO metadata request returns, it will take the request given and translate it into the SEO-friendly URL which search engines like to see. Having this SEO request and using it to style and describe your website parts like headers and titles also makes it much more user-friendly as they are easily able to tell what is going on and what they are looking at.

# Syntax

?seometadata=<seometadata item>&q=<optional request>

In this syntax, the "seometadata item" refers to a specific set of keywords that are configured in the Client Portal in the SEO Metadata config. Below is an example of what they could be

{
    "Book"{
        //Contents go in here for this SEO item
    },
    "Novel"{
    },
    "NewReleases"{
    }
}

The second part is an optional request, if none is specified then it will give a default one for the SEO metadata item specified however if a request is given it will produce the SEO metadata for that request with the given aspect and facets

# Example One

# Code

?seometadata=Books

Produces the result:

{
    "SeoMetadata":{
        "Query":"",
        "SeoUrl":"",
        "H1":"78,995,122 books for sale in Australia",
        "Title":"Books for sale in Australia - bookshop.com.au",
        "Description":"View our complete range of books, for sale throughout Australia",
    }
}

In this result, the basics are generated for the website including the H1, Title, and Description that can be displayed on a website.


# Example Two

# Code

?seometadata=Books&q=Genre.Fantasy.

Produces the result:

{
    "SeoMetadata":{
        "Query":"Genre.Fantasy.",
        "SeoUrl":"/Fantasy/",
        "H1":"188 Fantasy books for sale in Australia",
        "Title":"Fantasy books for sale in Australia - bookshop.com.au",
        "Description":"View our complete range of Fantasy books for sale throughout Australia",
    }
}

In this result, the items are much more specific towards the facet value, the number of available books has reduced to match the request and the website URL has been given a "SeoUrl" in order to make the website URL look much nicer and more human