v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

ShopShield

List ShopShield URIs for a site

get/v1/sites/{id}/shop_shield

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

uri_idstring

Search for URI IDs matching this string

Example:123e4567-e89b-12d3

uristring

Search for URIs matching this string

Example:/shop

pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

sort'id' | 'uri' | 'created_at' | 'updated_at'

sort results by this property

direction'asc' | 'desc' | 'ASC' | 'DESC'

Direction to sort results in (asc = ascending, desc = descending)

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  },
  "result": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "uri": "/",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}