API docs by Redocly

URL service API (1.0.0-url)

Download OpenAPI specification:

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

URL related service API

urls

URL service related operations

Returns all URLs for the given site key and locale

Returns all URLs for the given site key and locale.

Results can be paged using the query parameter limit along with an optional cursor of before or after.

Authorizations:
api_key
query Parameters
siteKey
required
string

The site key

locale
required
string

The ISO locale code

limit
required
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

before
required
string <= 10000

Cursor to retrieve results before.

after
required
string

Cursor to retrieve results after.

Responses

Response samples

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

Returns URL info for specific items

Returns URL info for specific items.

Note that although this is a POST request, nothing is created on the server. The POST verb is used because the request body is potentially large and the GET verb has a limit on the size of the request body.

Authorizations:
api_key
Request Body schema: application/json
required

The payload schema describes the information required to retrieve URL info for multiple items.

Array
type
required
string

The type of the asset being looked up

key
required
string

The key of the asset being looked up

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Returns all the assets data for the given asset type

Returns all the assets data for the given asset type

Results can be paged using the query parameter limit along with an optional cursor of before or after.

Authorizations:
api_key
path Parameters
type
required
string
Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "health-fund-page" "health-page" "home-page" "offer-page" "product" "product-listing-page" "store"

The asset type to retrieve

query Parameters
limit
required
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

before
required
string <= 10000

Cursor to retrieve results before.

after
required
string

Cursor to retrieve results after.

Responses

Response samples

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

Returns the asset data for the asset type and key

Returns the asset data for the asset type and key

Authorizations:
api_key
path Parameters
type
required
string
Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "health-fund-page" "health-page" "home-page" "offer-page" "product" "product-listing-page" "store"

The asset type to retrieve

key
required
string

The resource key

Responses

Response samples

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

Returns all the assets data for the given asset group type

Returns all the assets data for the given asset group type

Results can be paged using the query parameter limit along with an optional cursor of before or after.

Authorizations:
api_key
path Parameters
group-type
required
string
Enum: "content" "catalog"

The asset group type to retrieve

query Parameters
limit
required
number [ 1 .. 500 ]

The maximum number of results to return. 0 defaults to the maximum of 500

before
required
string <= 10000

Cursor to retrieve results before.

after
required
string

Cursor to retrieve results after.

Responses

Response samples

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

Returns the URL data for the given site and locale

Returns the URL data for the given site and locale

Authorizations:
api_key
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": {
    },
  • "metrics": {
    },
  • "context": {
    }
}

Returns the URL data for the given site, locale and path

Returns the URL data for the given site, locale and path

Authorizations:
api_key
path Parameters
siteKey
required
string

The key of the site for delivery options

locale
required
string

The ISO locale code

*
string

The wildcard should be the path of page to retrieve

Responses

Response samples

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

Returns the list of valid asset types

Returns the list of valid asset types

Authorizations:
api_key

Responses

Response samples

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

Health check information for the URL service

Health check information for the URL service

Authorizations:
api_key

Responses

Response samples

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

Check if URLs already exists for asset

Checks whether URLs exist for the specified asset type and key

Checks the current and pending URLs for an Asset and determines if the pending URL is a duplicate

Authorizations:
api_key
path Parameters
type
required
string
Enum: "blog-news-page" "brand-page" "category-page" "collection-page" "content-page" "health-fund-page" "health-page" "home-page" "offer-page" "product" "product-listing-page" "store"

The asset type to retrieve

key
required
string

The resource key

Responses

Response samples

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