API docs by Redocly

Render Graph API (1.0.0-render-graph)

Download OpenAPI specification:

URL: https://www.specsavers.co.uk License: UNLICENSED

Public facing Render Graph API for building pages

rendergraph

Retrieve page and component data for rendering in the UI

Health check information for the Render Graph service

Health check information for the Render Graph service

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a page by URL

Retrieve a render graph page for a give site, locale and URL

path Parameters
siteKey
required
string

The key of the site for delivery options

locale
required
string

The ISO locale code

url
required
string

The url of page to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get a component by ID

Retrieve a component for a give site and locale by ID

path Parameters
siteKey
required
string

The key of the site for delivery options

locale
required
string

The ISO locale code

id
required
string

The resource id

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get a site asset

Retrieves a site asset for the given site key and locale

path Parameters
siteKey
required
string

The key of the site for delivery options

locale
required
string

The ISO locale code

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "context": {
    },
  • "metrics": {
    }
}

Get all site locale/key info

Retrieves the key and locales for all sites

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "context": {
    },
  • "metrics": {
    }
}