search
get
/ccstore/v1/assembler/pages/{path: .*}
Search. Perform a search given an endeca based query. The response is a formatted endeca JSON that provides all the data based on the type of search. The URLs in the response are SEO optimized URLs.
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : assemblerPages_response
Type:
Show Source
object
-
breadcrumbs(optional):
object breadcrumbs
Breadcrumbs based on the given search query
- navigation(optional): object navigation
-
resultsList(optional):
object resultsList
List of all the results
-
searchAdjustments(optional):
object searchAdjustments
Search Adjustments of the given query
-
zones(optional):
object zones
Zone information where the content falls under
Nested Schema : resultsList
Type:
object
List of all the results
Show Source
-
firstRecNum(optional):
integer
First record number
-
lastRecNum(optional):
integer
Last record number
-
pagingActionTemplate(optional):
object pagingActionTemplate
Template of paging action
-
recsPerPage(optional):
integer
Number of records per page
-
totalNumRecs(optional):
integer
Total Number of Records in the result set
Nested Schema : searchAdjustments
Type:
object
Search Adjustments of the given query
Show Source
-
originalTerms(optional):
array originalTerms
List of all the original terms
Nested Schema : zones
Type:
object
Zone information where the content falls under
Show Source
-
@type(optional):
string
Zone type
-
offset(optional):
integer
Offset value
-
recordsPerPage(optional):
integer
Number of records per page
Nested Schema : pagingActionTemplate
Type:
object
Template of paging action
Show Source
-
@class(optional):
string
Path of NavigationAction class
-
contentPath(optional):
string
Path of the content
-
label(optional):
string
Label of action
- navigationState(optional): string
-
siteRootPath(optional):
string
Site Root path of endeca
Example Response (application/json)
{
"resultsList":{
"pagingActionTemplate":{
"link":"/gift-cards/_/N-9rp7fw?No=%7Boffset%7D&Nrpp=%7BrecordsPerPage%7D&Ntt=movie&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"lastRecNum":1,
"records":[
{
"detailsAction":{
"recordState":"/gift-cards/_/A-sku-giftCard-giftCardsku__1..giftCard__1?language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"records":[
{
"detailsAction":{
"recordState":"/gift-cards/_/R-sku-giftCard-giftCardsku__1..giftCard__1?language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"numRecords":0,
"attributes":{
"product.daysAvailable":[
"0"
],
"sku.activePrice":[
"25.000000"
],
"product.priceRange":[
"$20.00 - $29.99"
],
"sku.listingId":[
"giftCard_1"
],
"product.configurable":[
"0"
],
"product.displayName":[
"Movie Gift Card"
],
"sku.onSale":[
"0"
],
"product.dateAvailable":[
"1519159326000"
],
"product.primaryImageAltText":[
"Movie Gift Card"
],
"product.category":[
"Gift Cards"
],
"product.description":[
"Choose any denomination from $25 to $100."
],
"record.source":[
"ProductCatalog"
],
"product.primaryThumbImageURL":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=100&width=100"
],
"sku.availabilityStatus":[
"INSTOCK"
],
"sku.url":[
"atgrep:/ProductCatalog/sku-giftCard/giftCardsku_1?_product=giftCard_1"
],
"product.creationDate":[
"1519159326000"
],
"parentCategory.displayName":[
"Gift Cards"
],
"product.baseUrl":[
"atgrep:/ProductCatalog/sku-giftCard/giftCardsku_1"
],
"product.primaryLargeImageURL":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=940&width=940"
],
"sku.repositoryId":[
"giftCardsku_1"
],
"product.primaryImageTitle":[
"Movie Gift Card"
],
"sku.baseUrl":[
"atgrep:/ProductCatalog/sku-giftCard/giftCardsku_1"
],
"sku.displayName":[
"[DE]Gift card sample[DE]"
],
"record.type":[
"giftCard",
"sku-giftCard"
],
"product.largeImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=940&width=940"
],
"product.listPrice":[
"10.000000"
],
"product.route":[
"/movie-gift-card/product/giftCard_1"
],
"product.primaryFullImageURL":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg"
],
"record.type.raw":[
"giftCard",
"sku-giftCard"
],
"product.catalogId":[
"cloudCatalog",
"cloudLakeCatalog"
],
"record.id":[
"sku-giftCard-giftCardsku__1..giftCard__1"
],
"product.repositoryId":[
"giftCard_1"
],
"product.fullImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg"
],
"sku.listPrice":[
"25.000000"
],
"product.mediumImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=475&width=475"
],
"product.notForIndividualSale":[
"0"
],
"product.thumbImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=100&width=100"
],
"product.url":[
"atgrep:/ProductCatalog/sku-giftCard/giftCardsku_1?_product=giftCard_1"
],
"sku.active":[
"1"
],
"product.productImagesMetadata":[
"{}"
],
"product.primarySmallImageURL":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=300&width=300"
],
"product.sourceImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=300&width=300"
],
"sku.creationDate":[
"1519159326000"
],
"sku.listingOptionIndex":[
"10000"
],
"product.primaryMediumImageURL":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=475&width=475"
],
"product.active":[
"1"
],
"product.smallImageURLs":[
"/ccstore/v1/images/?source=/file/v3342232743798551492/products/GiftCard.jpg&height=300&width=300"
]
}
}
],
"numRecords":3,
"attributes":{
"product.repositoryId":[
"giftCard_1"
],
"sku.maxActivePrice":[
"100.000000"
],
"record.type.raw":[
"giftCard",
"sku-giftCard"
],
"sku.minActivePrice":[
"25.000000"
],
"record.id":[
"sku-giftCard-giftCardsku__1..giftCard__1"
]
}
}
],
"totalNumRecs":1,
"sortOptions":[
],
"@type":"ResultsList",
"endeca:auditInfo":{
"ecr:innerPath":"resultsList",
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
},
"firstRecNum":1,
"precomputedSorts":[
],
"recsPerPage":12
},
"endeca:contentPath":"/services/guidedsearch",
"navigation":{
"navigation":[
{
"@type":"RefinementMenu",
"displayName":"Price Range",
"name":"product.priceRange",
"ancestors":[
{
"link":"/gift-cards/_/N-9rp7fwZ1j7b3wx?Nrpp=12&Ntt=movie&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A",
"label":"$0.00 - $999.99",
"properties":{
"DGraph.More":"0",
"DGraph.Spec":"defaultPriceGroup:r0-1000",
"dimval.prop.lowerBound":"0.0",
"dimval.match_type":"range",
"dimval.prop.displayName_en_US":"$0.00 - $999.99",
"dimval.prop.upperBound":"1000.0",
"dimval.range.comparison_type":"decimal"
}
}
],
"dimensionName":"product.priceRange",
"multiSelect":false,
"refinements":[
{
"count":1,
"link":"/gift-cards/_/N-9rp7fwZdmy32l?Nrpp=12&Ntt=movie&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A",
"label":"$0.00 - $99.99",
"properties":{
"DGraph.Spec":"defaultPriceGroup:r0-100",
"dimval.prop.lowerBound":"0.0",
"dimval.match_type":"range",
"dimval.prop.displayName_en_US":"$0.00 - $99.99",
"dimval.prop.upperBound":"100.0",
"dimval.range.comparison_type":"decimal"
}
},
{
"count":1,
"link":"/gift-cards/_/N-9rp7fwZ1yobg6q?Nrpp=12&Ntt=movie&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A",
"label":"$100.00 - $199.99",
"properties":{
"DGraph.Spec":"defaultPriceGroup:r100-200",
"dimval.prop.lowerBound":"100.0",
"dimval.match_type":"range",
"dimval.prop.displayName_en_US":"$100.00 - $199.99",
"dimval.prop.upperBound":"200.0",
"dimval.range.comparison_type":"decimal"
}
}
]
}
],
"showAll":true,
"@type":"NavigationContainer",
"endeca:auditInfo":{
"ecr:innerPath":"navigation",
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
}
},
"endeca:assemblerRequestInformation":{
"endeca:contentPath":"/services/guidedsearch",
"@type":"AssemblerRequestEvent",
"endeca:numRecords":1,
"endeca:siteRootPath":"/pages",
"endeca:dimensionValues":[
"/product.category/Gift Cards"
],
"endeca:assemblyStartTimestamp":1.519667858474E12,
"endeca:assemblyFinishTimestamp":1.519667858559E12,
"endeca:eneTime":2,
"endeca:relRankStrategy":"nterms,field,maxfield,exact,static(product.displayName),static(sku.listingOptionIndex)",
"endeca:requestType":"UNKNOWN",
"endeca:dimensions":[
"product.category"
],
"endeca:numRefinements":1,
"endeca:requestId":"354",
"endeca:sessionId":"2D5CCE9C4D110A2214B409023A7602EB"
},
"@type":"GuidedSearchService",
"searchAdjustments":{
"@type":"SearchAdjustments",
"endeca:auditInfo":{
"ecr:innerPath":"searchAdjustments",
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
},
"originalTerms":[
"movie"
]
},
"additionalContent":{
"ruleLimit":1,
"contents":[
],
"@type":"ContentSlot",
"endeca:auditInfo":{
"ecr:innerPath":"additionalContent",
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
},
"contentPaths":[
"/content/additionalContent"
]
},
"endeca:auditInfo":{
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
},
"name":"Guided Search Service",
"endeca:siteRootPath":"/pages",
"endeca:siteState":{
"siteId":"@error:siteNotFound",
"properties":{
}
},
"breadcrumbs":{
"rangeFilterCrumbs":[
],
"searchCrumbs":[
{
"removeAction":{
"link":"/gift-cards/_/N-9rp7fw?Nrpp=12&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"terms":"movie",
"key":"All",
"matchMode":"allpartial"
}
],
"@type":"Breadcrumbs",
"endeca:auditInfo":{
"ecr:innerPath":"breadcrumbs",
"ecr:resourcePath":"/pages/Default/services/guidedsearch"
},
"removeAllAction":{
"link":"?language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"refinementCrumbs":[
{
"removeAction":{
"link":"?Nrpp=12&Ntt=movie&language=en&searchType=guided&visitId=18560618%3A16165656653%3A77c2-10.196.17.49&visitorId=10667tcaJcczeF1q1PVohySNrdNgrvLVazPcJmcfznOqfEM419A"
},
"displayName":"Category",
"count":1,
"label":"Gift Cards",
"ancestors":[
],
"dimensionName":"product.category",
"properties":{
"dimval.prop.category.repositoryId":"giftCards",
"DGraph.Spec":"giftCards",
"dimval.prop.category.ancestorCatalogIds":"cloudLakeCatalog",
"dimval.prop.displayName_en":"Gift Cards",
"dimval.prop.category.rootCatalogId":"cloudLakeCatalog",
"dimval.prop.category.catalogs.repositoryId":"cloudLakeCatalog,cloudCatalog",
"record.id":"atgrep:/ProductCatalog/category/giftCards?categoryPath=/giftCards"
},
"multiSelect":false
}
]
}
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code