Siteview

Siteview encapsulates the processes that deal with Slugs, Page schedule lists and fetching Site-views. This page covers some Siteview endpoints that are created to manage these processes programmatically

POST/api/v2/content/siteview/slug?slug=/

Get site view by slug.

This endpoint allows you to get site view by slug.

Developers - API Operations:

Operation	Endpoint	Response
Get Siteview	`/api/v2/content/siteview/slug?slug=/`	Get site view by slug.

Required attributes

Name
slug
Type
string
Description
Slug used to navigate to the site

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
boolean
Description
Result of the response
Name
id
Type
string
Description
id to identify the subscription
Name
name
Type
string
Description
Name of the site
Name
viewType
Type
string
Description
View type of the site
Name
slug
Type
string
Description
Slug to navigate to the site
Name
title
Type
string
Description
Title of the site
Name
layout
Type
string
Description
Layout of the site
Name
hrefLang
Type
string
Description
HREF language of the site
Name
htmlBody
Type
string
Description
HTML Body of the site
Name
canonical
Type
string
Description
Canonical tags of the site
Name
noFollow
Type
boolean
Description
Flag to check if no follow is set to true or not
Name
showInSitemap
Type
boolean
Description
Flag to check if show insite map is allowed or not
Name
allowAnonymous
Type
boolean
Description
Flag to check if anonymous access is allowed or not
Name
components
Type
array
Description
List of components that are assembled to build the site view
Name
componentId
Type
string
Description
Id used to identify the component
Name
componentType
Type
number
Description
Type of component used to create the site view
Name
content
Type
string
Description
Content provided inside the component
Name
displayOrder
Type
number
Description
Display order of the component in the list of components
Name
products
Type
array
Description
List of products in the component
Name
brands
Type
array
Description
List of brands in the component
Name
subBrands
Type
array
Description
List of sub-brands in the component
Name
categories
Type
array
Description
List of categories in the component
Name
subCategories
Type
array
Description
List of sub-categories in the component
Name
images
Type
array
Description
List of images in the component
Name
banners
Type
array
Description
List of banners in the component
Name
image
Type
object
Description
Object containing values of the image in the component
Name
blogs
Type
array
Description
List of blogs for the site in the component
Name
dataType
Type
string
Description
Data type of the component
Name
dataNumItemsRow
Type
string
Description
Data for number of items per row
Name
autoplay
Type
boolean
Description
Flag to check if the component is allowed to autoplay
Name
sliderTime
Type
string
Description
Slider time for sliding banners in the component
Name
link
Type
string
Description
Link of the component
Name
productListDisplayType
Type
string
Description
Type of display for the product list in the component
Name
categoryListDisplayType
Type
string
Description
Type of display for the category list in the component
Name
brandListDisplayType
Type
string
Description
Type of display for the Brand list in the component
Name
productEnableButton
Type
string
Description
Value for button to enable the product
Name
categoryEnableButton
Type
string
Description
Value for button to enable the category
Name
brandEnableButton
Type
string
Description
Value for button to enable the brand
Name
viewType
Type
string
Description
View type of the component
Name
buttonText
Type
string
Description
Text of the button in the component
Name
buttonType
Type
string
Description
Type of button in the component
Name
widgetPath
Type
string
Description
Path for the widgets in the component
Name
title
Type
string
Description
Title of the component
Name
subTitle
Type
string
Description
Sub-title of the component
Name
paragraph
Type
string
Description
Paragraph for text content inside a component
Name
dataAlignment
Type
string
Description
Value for data alignment inside the component
Name
textAlignment
Type
string
Description
Value for alignment of text in the component
Name
textVerticalAlignment
Type
string
Description
Value for vertical alignment of text in the component
Name
buttonClass
Type
string
Description
Button class of the button in the component
Name
redirectTypeValue
Type
number
Description
Type of redirect from the site e.g. 301-Permanent, 302-Found and 307-Temporary
Name
metaTitle
Type
string
Description
Meta title of the site
Name
metaDescription
Type
string
Description
Meta description of the site
Name
metaKeywords
Type
string
Description
Meta keywords of the site
Name
versionNo
Type
number
Description
Version number of the site
Name
scheduleItems
Type
array
Description
List of scheduled items on the site
Name
name
Type
string
Description
Name of he scheduled item
Name
from
Type
string
Description
Date and time of the starting time of the scheduled item
Name
to
Type
string
Description
Date and time of the ending time of the scheduled item
Name
neverExpire
Type
boolean
Description
Flag to check if the schedule should never expire
Name
versionNo
Type
number
Description
Version number of the scheduled item
Name
snippets
Type
array
Description
List of content snippets to be placed in the site
Name
name
Type
string
Description
Name of the snippet
Name
type
Type
number
Description
Type of snippet as a numeric value
Name
placement
Type
number
Description
Placement position of the snippet on the site
Name
content
Type
string
Description
Content of the snippet
Name
excludedUrl
Type
string
Description
Excluded URL of the site
Name
microsites
Type
array
Description
List of micro sites in the snippet
Name
slugType
Type
number
Description
Type of slug as a numeric value

Request

POST

/api/v2/content/siteview/slug?slug=/

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/content/siteview/slug?slug=%2F' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; 
ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 402,
"status": "commo",
"errors": [
    "Ut pariatur laboris co",
    "esse qui consequat"
],
"success": false,
"message": "esse",
"messageCode": "elit",
"result": {
    "id": "aliqua Duis amet eiusmod",
    "name": "veniam sunt minim",
    "viewType": "id nisi",
    "slug": "dolor pariatur sunt",
    "title": "ullamco anim sunt",
    "layout": "proident",
    "hrefLang": "pariatur consequat",
    "htmlBody": "nostrud do irure quis sit",
    "canonical": "et nisi proident Duis",
    "noFollow": false,
    "showInSitemap": true,
    "allowAnonymous": true,
    "components": [
        {
            "componentId": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "componentType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "content": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "displayOrder": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "products": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brands": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subBrands": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categories": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subCategories": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "images": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "banners": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "image": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "blogs": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataNumItemsRow": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "autoplay": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "sliderTime": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "link": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "productListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categoryListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brandListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "productEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categoryEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brandEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "viewType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonText": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "widgetPath": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "title": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subTitle": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "paragraph": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "textAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "textVerticalAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonClass": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            }
        },
    ],
    "redirectTypeValue": -50890518,
    "metaTitle": "deserunt esse pariatur consequat",
    "metaDescription": "fugiat",
    "metaKeywords": "labore consequat",
    "versionNo": -69752733,
    "scheduleItems": [
        {
            "name": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "from": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "to": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "neverExpire": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "versionNo": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            }
        },
    ]
},
"snippets": [
    {
        "name": "voluptate ipsum ei",
        "type": 3,
        "placement": 16,
        "content": "anim",
        "excludedUrl": "e",
        "microsites": [
            "00000000-0000-0000-0000-000000000000",
            "00000000-0000-0000-0000-000000000000"
        ]
    },
],
"slugType": 3
}

POST/api/v2/content/siteview/dynamic-slug?slug=products/lacoste-lacoste-croco-pool-sandal-mens-7-37cma0015-red-9

Get entity specific data based on slug passed .

This endpoint allows you to get entity specific data based on slug passed - product, brand, siteview, category, product collection.

Developers - API Operations:

Operation	Endpoint	Response
Get Data	`/api/v2/content/siteview/dynamic-slug?slug=products/lacoste-lacoste-croco-pool-sandal-mens-7-37cma0015-red-9`	Get entity specific data based on slug passed.

Required attributes

Name
slug
Type
string
Description
Slug used to navigate to the site

Request

POST

/api/v2/content/siteview/dynamic-slug?slug=products/lacoste-lacoste-croco-pool-sandal-mens-7-37cma0015-red-9

curl --location --request POST 'https://api20.bettercommerce.io/api/v2/content/siteview/dynamic-slug?slug=products%2Flacoste-lacoste-croco-pool-sandal-mens-7-37cma0015-red-9' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; 
ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

GET/api/v2/content/siteview/id/:id?version=-12523966&langCulture=proident culpa anim nisi aliquip

Get site view by id, lang, version.

This endpoint allows you to get site view by id, lang, version.

Developers - API Operations:

Operation	Endpoint	Response
Get Siteview	`/api/v2/content/siteview/id/:id?version=-12523966&langCulture=proident culpa anim nisi aliquip`	Get site view by id, lang, version.

Required attributes

Name
id
Type
string
Description
Id used to identify the site
Name
version
Type
number
Description
Version of the site
Name
langCulture
Type
string
Description
Language culture code of the site e.g. en-US(English-United States)

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
boolean
Description
Result of the response
Name
id
Type
string
Description
id to identify the subscription
Name
name
Type
string
Description
Name of the site
Name
viewType
Type
string
Description
View type of the site
Name
slug
Type
string
Description
Slug to navigate to the site
Name
title
Type
string
Description
Title of the site
Name
layout
Type
string
Description
Layout of the site
Name
hrefLang
Type
string
Description
HREF language of the site
Name
htmlBody
Type
string
Description
HTML Body of the site
Name
canonical
Type
string
Description
Canonical tags of the site
Name
noFollow
Type
boolean
Description
Flag to check if no follow is set to true or not
Name
showInSitemap
Type
boolean
Description
Flag to check if show insite map is allowed or not
Name
allowAnonymous
Type
boolean
Description
Flag to check if anonymous access is allowed or not
Name
components
Type
array
Description
List of components that are assembled to build the site view
Name
componentId
Type
string
Description
Id used to identify the component
Name
componentType
Type
number
Description
Type of component used to create the site view
Name
content
Type
string
Description
Content provided inside the component
Name
displayOrder
Type
number
Description
Display order of the component in the list of components
Name
products
Type
array
Description
List of products in the component
Name
brands
Type
array
Description
List of brands in the component
Name
subBrands
Type
array
Description
List of sub-brands in the component
Name
categories
Type
array
Description
List of categories in the component
Name
subCategories
Type
array
Description
List of sub-categories in the component
Name
images
Type
array
Description
List of images in the component
Name
banners
Type
array
Description
List of banners in the component
Name
image
Type
object
Description
Object containing values of the image in the component
Name
blogs
Type
array
Description
List of blogs for the site in the component
Name
dataType
Type
string
Description
Data type of the component
Name
dataNumItemsRow
Type
string
Description
Data for number of items per row
Name
autoplay
Type
boolean
Description
Flag to check if the component is allowed to autoplay
Name
sliderTime
Type
string
Description
Slider time for sliding banners in the component
Name
link
Type
string
Description
Link of the component
Name
productListDisplayType
Type
string
Description
Type of display for the product list in the component
Name
categoryListDisplayType
Type
string
Description
Type of display for the category list in the component
Name
brandListDisplayType
Type
string
Description
Type of display for the Brand list in the component
Name
productEnableButton
Type
string
Description
Value for button to enable the product
Name
categoryEnableButton
Type
string
Description
Value for button to enable the category
Name
brandEnableButton
Type
string
Description
Value for button to enable the brand
Name
viewType
Type
string
Description
View type of the component
Name
buttonText
Type
string
Description
Text of the button in the component
Name
buttonType
Type
string
Description
Type of button in the component
Name
widgetPath
Type
string
Description
Path for the widgets in the component
Name
title
Type
string
Description
Title of the component
Name
subTitle
Type
string
Description
Sub-title of the component
Name
paragraph
Type
string
Description
Paragraph for text content inside a component
Name
dataAlignment
Type
string
Description
Value for data alignment inside the component
Name
textAlignment
Type
string
Description
Value for alignment of text in the component
Name
textVerticalAlignment
Type
string
Description
Value for vertical alignment of text in the component
Name
buttonClass
Type
string
Description
Button class of the button in the component
Name
redirectTypeValue
Type
number
Description
Type of redirect from the site e.g. 301-Permanent, 302-Found and 307-Temporary
Name
metaTitle
Type
string
Description
Meta title of the site
Name
metaDescription
Type
string
Description
Meta description of the site
Name
metaKeywords
Type
string
Description
Meta keywords of the site
Name
versionNo
Type
number
Description
Version number of the site
Name
scheduleItems
Type
array
Description
List of scheduled items on the site
Name
name
Type
string
Description
Name of he scheduled item
Name
from
Type
string
Description
Date and time of the starting time of the scheduled item
Name
to
Type
string
Description
Date and time of the ending time of the scheduled item
Name
neverExpire
Type
boolean
Description
Flag to check if the schedule should never expire
Name
versionNo
Type
number
Description
Version number of the scheduled item
Name
snippets
Type
array
Description
List of content snippets to be placed in the site
Name
name
Type
string
Description
Name of the snippet
Name
type
Type
number
Description
Type of snippet as a numeric value
Name
placement
Type
number
Description
Placement position of the snippet on the site
Name
content
Type
string
Description
Content of the snippet
Name
excludedUrl
Type
string
Description
Excluded URL of the site
Name
microsites
Type
array
Description
List of micro sites in the snippet
Name
slugType
Type
number
Description
Type of slug as a numeric value

Request

GET

/api/v2/content/siteview/id/:id?version=-12523966&langCulture=proident culpa anim nisi aliquip

curl --location 'https://api20.bettercommerce.io/api/v2/content/siteview/id/proident culpa anim nisi aliquip?version=-12523966&langCulture=proident%20culpa%20anim%20nisi%20aliquip' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; 
ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 412,
"status": "quis eiusmod nulla dolor veniam",
"errors": [
    "Except",
    "in ad amet"
],
"success": true,
"message": "mollit nisi ex Ut velit",
"messageCode": "laborum ea consectetur",
"result": {
    "id": "ullamco",
    "name": "adipisicing dolor exercitation",
    "viewType": "adipisicing sit esse ad",
    "slug": "do Duis esse",
    "title": "fugiat sunt elit non",
    "layout": "Excepteur reprehenderit ipsum",
    "hrefLang": "enim qui id",
    "htmlBody": "deserunt id",
    "canonical": "deserunt ut",
    "noFollow": false,
    "showInSitemap": true,
    "allowAnonymous": true,
    "components": [
        {
            "componentId": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "componentType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "content": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "displayOrder": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "products": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brands": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subBrands": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categories": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subCategories": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "images": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "banners": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "image": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "blogs": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataNumItemsRow": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "autoplay": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "sliderTime": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "link": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "productListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categoryListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brandListDisplayType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "productEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "categoryEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "brandEnableButton": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "viewType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonText": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonType": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "widgetPath": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "title": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "subTitle": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "paragraph": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "dataAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "textAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "textVerticalAlignment": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "buttonClass": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            }
        },
    ],
    "redirectTypeValue": 76415982,
    "metaTitle": "occaecat sit",
    "metaDescription": "incididunt nisi ipsum qui Duis",
    "metaKeywords": "dolore in anim laborum",
    "versionNo": -68892095,
    "scheduleItems": [
        {
            "name": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "from": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "to": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "neverExpire": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "versionNo": {
                "value": "<Error: Too many levels of nesting to fake this schema>"
            }
        }
    ]
},
"snippets": [
    {
        "name": "dolor cupidatat",
        "type": 2,
        "placement": 8,
        "content": "Duis in irure",
        "excludedUrl": "fugiat cillum i",
        "microsites": [
            "00000000-0000-0000-0000-000000000000",
            "00000000-0000-0000-0000-000000000000"
        ]
    }
],
"slugType": 2
}

GET/api/v2/content/siteview/all

Get all slugs.

This endpoint allows you to get all slugs.

Developers - API Operations:

Operation	Endpoint	Response
Get Slugs	`/api/v2/content/siteview/all`	Get all slugs.

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
array
Description
List of all slugs in siteview contents

Request

GET

/api/v2/content/siteview/all

curl --location 'https://api20.bettercommerce.io/api/v2/content/siteview/all' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; 
ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 406,
"status": "cillum",
"errors": [
    "et labore aute",
    "Ut enim minim voluptate"
],
"success": false,
"message": "Ut e",
"messageCode": "magna commodo",
"result": [
    "culpa consequat ad deserunt",
    "elit dolore"
]
}

GET/api/v2/content/siteview/schedule/active

Get page schedule list.

This endpoint allows you to get page schedule list.

Developers - API Operations:

Operation	Endpoint	Response
Get Siteview	`/api/v2/content/siteview/schedule/active`	Get page schedule list.

Response Properties

Name
statusCode
Type
number
Description
Status code of the response
Name
status
Type
string
Description
Status of the response
Name
errors
Type
array
Description
List of errors in the response
Name
success
Type
boolean
Description
Success status of the response
Name
message
Type
string
Description
Message of the response
Name
messageCode
Type
string
Description
Message code of the response
Name
result
Type
boolean
Description
Result of the response
Name
recordId
Type
string
Description
Record Id used to identify the record of scheduled item
Name
name
Type
string
Description
Name of he scheduled item
Name
from
Type
string
Description
Date and time of the starting time of the schedule
Name
to
Type
string
Description
Date and time of the ending time of the schedule
Name
neverExpire
Type
boolean
Description
Flag to check if the schedule should never expire
Name
comment
Type
string
Description
Comments about the page schedule
Name
isActive
Type
boolean
Description
Flag to check if the schedule is active
Name
lastUpdatedBy
Type
string
Description
Name of the user who last updated the schedule
Name
lastUpdated
Type
string
Description
Date and time whent the page schedule was last updated

Request

GET

/api/v2/content/siteview/schedule/active

curl --location 'https://api20.bettercommerce.io/api/v2/content/siteview/schedule/active' \
--header 'Cookie: ARRAffinity=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597; 
ARRAffinitySameSite=b13bb339e1ac28f5b31d8289818f929ee76838eb63e5c727c2b61a385a402597'

Response

{
"statusCode": 200,
"status": "elit nost",
"errors": [
    "enim exercitation reprehenderit",
    "qui laborum velit"
],
"success": false,
"message": "Lore",
"messageCode": "aute cupidatat incididunt voluptate dolor",
"result": [
    {
        "recordId": "00000000-0000-0000-0000-000000000000",
        "name": "aliquip reprehenderit ex sunt",
        "from": "2012-11-23T14:02:35.322Z",
        "to": "1990-10-09T16:37:55.321Z",
        "neverExpire": true,
        "comment": "reprehenderit eiusmod tempor aliqua",
        "isActive": true,
        "lastUpdatedBy": "voluptate consectetur incididunt amet nisi",
        "lastUpdated": "officia enim mollit"
    },
    {
        "recordId": "00000000-0000-0000-0000-000000000000",
        "name": "consequat Lorem pariatur Ut",
        "from": "1968-12-01T02:44:24.952Z",
        "to": "1989-07-18T09:47:16.154Z",
        "neverExpire": false,
        "comment": "non ipsum",
        "isActive": true,
        "lastUpdatedBy": "dolor quis sint exercitation ad",
        "lastUpdated": "dolor elit non ex"
    }
]
}