Bazaarvoice actions

Bazaarvoice component actions.

Retrieve reviews

The in/out metadata can be found at /lib/schemas/retrieveReviews.{in/out}.json

Here is the usage example of the input message:

{
    "productId": "data-gen-moppq9ekthfzbc6qff3bqokie",
    "limit": 2
}

output message:

{
	"Limit": 2,
	"Offset": 0,
	"TotalResults": 46,
	"Locale": "en_US",
	"Results": [
		{
			"Id": "19452186",
			"CID": "06ea82a9-7ee4-5584-9db3-37ecb220dca3",
			"SourceClient": "conciergeapidocumentation",
			"LastModeratedTime": "2017-04-17T08:15:01.000+00:00",
			"LastModificationTime": "2017-04-17T08:15:01.000+00:00",
			"ProductId": "data-gen-moppq9ekthfzbc6qff3bqokie",
			"AuthorId": "58f478911803d",
			"ContentLocale": "en_US",
		},
		{
			"Id": "19452183",
			"CID": "8f1c87b6-e31e-5852-949f-da388bba1807",
			"SourceClient": "conciergeapidocumentation",
			"Badges": [
				null
			],
			"BadgesOrder": [
				null
			],
			"LastModeratedTime": "2017-04-17T08:15:01.000+00:00",
			"LastModificationTime": "2017-04-17T08:15:01.000+00:00",
			"ProductId": "data-gen-moppq9ekthfzbc6qff3bqokie",
			"ContextDataValuesOrder": [
				null
			],
			"AuthorId": "58f478579d967",
			"ContentLocale": "en_US",
		}
	],
	"Includes": {}
}

Submit review

The in/out metadata can be found at /lib/schemas/submitReview.{in/out}.json

Here is an example input message:

{
	"authorSecurityInformation": {
		"authorIP": "127.0.0.1",
		"authorDeviceFingerprint": "0cto0jqrnfdsoolitatph0g5reoen1du",
		"externalAuthorId": "asdasd",
		"isAuthorAgreedToTermsAndConditions": true
	},
	"productId": "data-gen-moppq9ekthfzbc6qff3bqokie1234",
	"rating": 5,
	"title": "My title",
	"reviewText": "My review text",
	"authorNickname": "user123"
}

output message:

{
	"Locale": "en_US",
	"Form": [],
	"SubmissionId": "tu10wxc1lcmgh7kozs49bh0iu",
	"TypicalHoursToPost": 72,
	"Data": {},
	"Review": {
		"SendEmailAlertWhenCommented": false,
		"Rating": 5,
		"SubmissionTime": "2018-04-04T15:28:18.152+00:00",
		"ReviewText": "My review text",
		"SubmissionId": null,
		"Title": "My title",
		"IsRecommended": null,
		"TypicalHoursToPost": null,
		"Id": null,
		"SendEmailAlertWhenPublished": false
	},
	"AuthorSubmissionToken": "90a8ecb07d49e47ee6df9bff4b47a18b7573657269643d6"
}

Retrieve products

The in/out metadata can be found at /lib/schemas/retrieveProducts.{in/out}.json

An example of input message:

{
	"productsIds": [
		"data-gen-moppq9ekthfzbc6qff3bqokie"
	],
	"limit": null,
	"offset": null,
	"stats": "Questions",
    "searchString": null
}

output message:

{
	"Limit": 10,
	"Offset": 0,
	"TotalResults": 1,
	"Locale": "en_US",
	"Results": [
		{
			"Description": "Increase your potential to shine ...",
			"ImageUrl": "http://myshco.com/productImages/teardrop.jpg",
			"Name": "14K White Gold Diamond Teardrop Necklace",
			"Id": "data-gen-moppq9ekthfzbc6qff3bqokie",
			"CategoryId": "data-gen-ejcf7ia6yt7iw82ewnh3dhmyc",
			"Active": false,
			"Disabled": false,
			"ISBNs": [],
			"BrandExternalId": null,
			"QuestionIds": [],
			"ManufacturerPartNumbers": [],
			"FamilyIds": [],
			"EANs": [],
			"StoryIds": [],
			"AttributesOrder": [],
			"ModelNumbers": [],
			"UPCs": [],
			"Brand": {},
			"Attributes": {},
			"ProductPageUrl": null,
			"ReviewIds": [],
			"QAStatistics": { },
			"TotalQuestionCount": 20,
			"TotalAnswerCount": 11
		}
	],
	"Includes": {}
}

Retrieve categories

The in/out metadata can be found at /lib/schemas/retrieveCategories.{in/out}.json

The input message:

{
	"categoriesIds": [
		"data-gen-t3jxodbtmy8n9fzn1vm88yjec"
	],
	"limit": 2,
	"offset": null
}

output message:

{
	"Limit": 2,
	"Offset": 0,
	"TotalResults": 1,
	"Locale": "en_US",
	"Results": [
		{
			"Name": "Financial",
			"Id": "data-gen-t3jxodbtmy8n9fzn1vm88yjec",
			"ParentId": "data-gen-hv0nntimw0bvtn3czb4l0k5tn",
			"Active": false,
			"Disabled": false,
			"ImageUrl": null,
			"CategoryPageUrl": null,
			"StoryIds": [],
			"QuestionIds": [],
			"ProductIds": [],
			"Attributes": {},
			"AttributesOrder": []
		}
	],
	"Includes": {}
}

Retrieve statistics

The in/out metadata can be found at /lib/schemas/retrieveStatistics.{in/out}.json

There are 2 supported statistic’s content types:

Reviews
NativeReviews

An input message:

{
	"productsIds": [
		"data-gen-2s9kaf0ugzn0p2flzl73ahuys"
	],
	"statsContentTypes": [
		"Reviews",
		"NativeReviews"
	],
	"contentLocales": [
		"en_US",
		"es_US"
	]
}

output message:

{
	"Limit": 1,
	"Offset": 0,
	"TotalResults": 1,
	"Locale": "en_US",
	"Results": [
		{
			"ProductStatistics": {
				"ProductId": "data-gen-2s9kaf0ugzn0p2flzl73ahuys",
				"NativeReviewStatistics": {
					"AverageOverallRating": 4.55,
					"TotalReviewCount": 20,
					"OverallRatingRange": 5
				},
				"ReviewStatistics": {
					"AverageOverallRating": 4.55,
					"TotalReviewCount": 20,
					"OverallRatingRange": 5
				}
			}
		}
	],
	"Includes": {}
}

Retrieve comments

The in/out metadata can be found at /lib/schemas/retrieveComments.{in/out}.json

An input message:

{
	"commentId": "338201",
	"reviewId": null,
	"productId": null,
	"limit": null,
	"offset": null,
	"subjectsToInclude": [
		"authors",
		"products",
		"categories"
	],
	"attributes": [
		"ModeratorCodes"
	],
	"excludeFamily": false,
	"locale": "en_US"
}

output message:

{
	"Limit": 10,
	"Offset": 0,
	"TotalResults": 1,
	"Locale": "en_US",
	"Results": [
		{
			"Id": "338201",
			"CID": "fb2f0b8c-b364-5f01-b1a2-b4b8b1ace006",
			"SourceClient": "conciergeapidocumentation",
			"LastModeratedTime": "2017-01-05T19:22:16.000+00:00",
			"LastModificationTime": "2017-01-05T19:24:52.000+00:00",
			"ReviewId": "16970457",
			"Badges": {
				"Expert": {
					"ContentType": "COMMENT",
					"Id": "Expert",
					"BadgeType": "Rank"
				},
				"Staff": {
					"ContentType": "COMMENT",
					"Id": "Staff",
					"BadgeType": "Affiliation"
				}
			},
			"BadgesOrder": [
				"Expert",
				"Staff"
			],
			"AuthorId": "data-gen-user-poaouvr127us1ijhpafkfacb9",
			"ModeratorCodes": [
				"IMP"
			],
			"UserLocation": "Berkeley, CA",
			"ContentLocale": "en_US",
			"IsFeatured": false,
			"TotalFeedbackCount": 9,
		}
	],
	"Includes": {
		"Products": {
			"data-gen-3jxhm78sfqfy8tg5qyinqioal": {
				"Description": "This extra-large capacity ...",
				"ImageUrl": "http://myshco.com/productImages/profile.png",
				"Name": "GE Profile 7.5 Cu. Ft. Colossal Capacity Electric Dryer",
				"Id": "data-gen-3jxhm78sfqfy8tg5qyinqioal",
				"CategoryId": "data-gen-t3jxodbtmy8n9fzn1vm88yjec",
			}
		},
		"Categories": {
			"data-gen-t3jxodbtmy8n9fzn1vm88yjec": {
				"Name": "Financial",
				"Id": "data-gen-t3jxodbtmy8n9fzn1vm88yjec",
				"ParentId": "data-gen-hv0nntimw0bvtn3czb4l0k5tn",
			}
		},
		"Authors": {
			"data-gen-user-poaouvr127us1ijhpafkfacb9": {
				"Id": "data-gen-user-poaouvr127us1ijhpafkfacb9",
				"Badges": {
					"Expert": {
						"ContentType": "REVIEWER",
						"Id": "Expert",
						"BadgeType": "Rank"
					},
					"Staff": {
						"ContentType": "REVIEWER",
						"Id": "Staff",
						"BadgeType": "Affiliation"
					}
				},
				"BadgesOrder": [
					"Expert",
					"Staff"
				],
				"ContributorRank": "NONE",
				"UserNickname": "ferdinand255",
				"LastModeratedTime": "2017-01-05T19:22:28.000+00:00",
				"ModerationStatus": "APPROVED",
				"SubmissionTime": "2016-01-06T11:52:00.000+00:00",
			}
		},
		"ProductsOrder": [
			"data-gen-3jxhm78sfqfy8tg5qyinqioal"
		],
		"AuthorsOrder": [
			"data-gen-user-poaouvr127us1ijhpafkfacb9"
		],
		"CategoriesOrder": [
			"data-gen-t3jxodbtmy8n9fzn1vm88yjec"
		]
	}
}

Submit question

The in/out metadata can be found at /lib/schemas/submitQuestion.{in/out}.json

An input message:

{
	"authorSecurityInformation": {
		"authorIP": "127.0.0.1",
		"authorDeviceFingerprint": "0cto0jqrnfdsoolitatph0g5reoen1du",
		"externalAuthorId": "asdasd",
		"isAuthorAgreedToTermsAndConditions": true,
		"hostedAuthenticationEmail": null,
		"hostedAuthenticationCallbackUrl": null
	},
	"productId": "data-gen-moppq9ekthfzbc6qff3bqokie123456",
	"questionSummary": "what is the capital of great britain?",
	"questionDetails": "asd qwe what is the capital of great britain?",
	"authorNickname": "fredddy123",
	"isUserAnonymous": false,
	"locale": "en_US",
	"userEmail": "asdasdasd@example.com"
}

output message:

{
	"Locale": "en_US",
	"Form": [],
	"SubmissionId": "u3uy0dhz5qilrirs8tgogqo1u",
	"Question": {
		"QuestionSummary": "what is the capital of great britain?",
		"SubmissionTime": "2018-04-17T11:29:15.002+00:00",
		"SubmissionId": null,
		"SendEmailAlertWhenAnswered": false,
		"TypicalHoursToPost": null,
		"QuestionDetails": "asd qwe what is the capital of great britain?",
		"Id": null,
		"SendEmailAlertWhenPublished": false
	},
	"TypicalHoursToPost": 72,
	"Data": {},
	"AuthorSubmissionToken": "621e1ca874ebadbb9a7db3ff68652e7075736572"
}

Submit answer

The in/out metadata can be found at /lib/schemas/submitAnswer.{in/out}.json

An input message:

{
	"authorSecurityInformation": {
		"authorIP": "127.0.0.1",
		"authorDeviceFingerprint": "0cto0jqrnfdsoolitatph0g5reoen1du",
		"externalAuthorId": "asdasd",
		"isAuthorAgreedToTermsAndConditions": true,
		"hostedAuthenticationEmail": null,
		"hostedAuthenticationCallbackUrl": null
	},
	"AnswerText": "answer 123123 asdasdqweqwe",
	"QuestionId": "646785",
	"CampaignId": "post-purchase email",
	"Locale": "en_US",
	"SendEmailAlertWhenPublished": false,
	"UserEmail": "asdasdqwe@example.com",
	"UserLocation": "USA",
	"UserNickname": "user123"
}

output message:

{
	"Locale": "en_US",
	"Answer": {
		"SubmissionTime": "2018-04-17T12:29:40.599+00:00",
		"SubmissionId": null,
		"AnswerText": "answer 123123 asdasdqweqwe",
		"TypicalHoursToPost": null,
		"Id": null,
		"SendEmailAlertWhenPublished": false
	},
	"Form": [],
	"SubmissionId": "egk3w9b6wtt3mgikb58hlay8q",
	"TypicalHoursToPost": 72,
	"Data": {},
	"AuthorSubmissionToken": "621e1ca874ebadbb9a7db3ff68652e707573657269"
}

Submit comment

The in/out metadata can be found at /lib/schemas/submitComment.{in/out}.json

An input message:

{
	"authorSecurityInformation": {
		"authorIP": "127.0.0.1",
		"authorDeviceFingerprint": "0cto0jqrnfdsoolitatph0g5reoen1du",
		"externalAuthorId": "asdasd",
		"hostedAuthenticationEmail": null,
		"hostedAuthenticationCallbackUrl": null
	},
	"Title": "comment title",
	"CommentText": "comment 123123 asdasdqweqwe",
	"CampaignId": "post-purchase email",
	"Locale": "en_US",
	"ReviewId": "16970607",
	"SendEmailAlertWhenPublished": false,
	"UserEmail": "asdasdqwe@example.com",
	"UserLocation": "USA",
	"UserNickname": "user123"
}

output message:

{
	"Locale": "en_US",
	"Comment": {
		"SubmissionTime": "2018-04-17T12:44:36.500+00:00",
		"CommentText": "comment 123123 asdasdqweqwe",
		"SubmissionId": null,
		"Title": "comment title",
		"TypicalHoursToPost": null,
		"Id": null,
		"SendEmailAlertWhenPublished": false
	},
	"Form": [],
	"SubmissionId": "etu86zfzwl8676tf2u30w7xnx",
	"TypicalHoursToPost": 72,
	"Data": {},
	"AuthorSubmissionToken": "621e1ca874ebadbb9a7db3ff68652e70757365726"
}

Submit photo

The in/out metadata can be found at /lib/schemas/submitPhoto.{in/out}.json

An input message:

{
	"authorSecurityInformation": {
		"externalAuthorId": "craiggil"
	},
	"photoUrl": "https://url-to-image",
	"Locale": "en_US",
	"ContentType": "review"
}

output message:

{
	"Locale": "en_US",
	"Form": [
		{
			"Type": "Field",
			"Id": "photo"
		}
	],
	"SubmissionId": null,
	"Data": {
		"Fields": {
			"photo": {
				"Options": [],
				"Type": "FileInput",
				"Required": null,
				"Label": null,
				"Value": null,
				"MinLength": null,
				"Id": "photo",
				"MaxLength": null,
				"Default": null
			}
		},
		"Groups": {},
		"FieldsOrder": [
			"photo"
		],
		"GroupsOrder": []
	},
	"Photo": {
		"Sizes": {
			"normal": {
				"Id": "normal",
				"Url": "https://url-to-image"
			},
			"thumbnail": {
				"Id": "thumbnail",
				"Url": "https://rurl-to-image"
			}
		},
		"Id": "l0r7l2xvmaytb6fph0ubp5u4j",
		"SizesOrder": [
			"thumbnail",
			"normal"
		],
		"Caption": null
	},
	"TypicalHoursToPost": null,
	"AuthorSubmissionToken": null
}

Submit feedback

The in/out metadata can be found at /lib/schemas/submitFeedback.{in/out}.json

An input message:

{
	"authorSecurityInformation": {
		"authorIP": "127.0.0.1"
	},
	"ContentId": "21849200",
	"ContentType": "review",
	"FeedbackType": "helpfulness",
	"Vote": "Positive"
}

output message:

{
	"Locale": "en_US",
	"Feedback": {
		"Helpfulness": {
			"Vote": "POSITIVE",
			"AuthorId": "ztchk5phl7pj0yifdcx8pqhjnw"
		}
	},
	"Form": [],
	"SubmissionId": null,
	"Data": {},
	"TypicalHoursToPost": null,
	"AuthorSubmissionToken": null
}

Retrieve curations content

The in/out metadata can be found at /lib/schemas/retrieveCurationsContent.{in/out}.json

The source doc can be located here.

An input message:

{
	"productId": null,
	"client": "branddemo",
	"display": [
		"livebv",
		"roadtriplandingpage"
	],
	"after": null,
	"before": null,
	"limit": 1
}

output message:

{
	"status": "ok",
	"code": 200,
	"total": 51,
	"results": 1,
	"updates": [
		{
			"data": {
				"links": [],
				"photos": [
					{
						"role": "photo",
						"origin": "instagram",
						"token": "https://url-to-resource",
						"image_service_url": "https://url-to-resource",
						"url": "https://url-to-resource",
						"display_url": "https://url-to-resource"
					}
				],
				"videos": [],
				"tags": [
					"livebv",
					"thesourcecanada",
					"sourcecanada",
					"SpringCampaign"
				],
				"author": {
					"alias": "Remote BV",
					"channel": "instagram",
					"token": "4006361074",
					"avatar": "https://api.bazaarvoice.com/curations/url-to-resource",
					"profile": "https://instagram.com/remote_bv"
				},
				"groups": [
					"__all__"
				],
				"sourceClient": "branddemo",
				"classification": "photo",
				"text": "Just another day in the office! #remotebv #livebv",
				"language": "eng",
				"timestamp": 1491442326,
				"token": "1486648444605264908_4006361074",
				"id": "58e5a15bbe1f2d0100f8b447",
				"permalink": "https://www.instagram.com/p/BShouI-lXQM/",
				"productId": "",
				"channel": "instagram",
				"_platform": "c3"
			}
		}
	],
	"productData": {},
	"options": {
		"sourceParameters": {
			"apiversion": "5.4",
			"productId": "",
			"client": "branddemo",
			"display": "livebv,roadtriplandingpage",
			"after": "",
			"before": "",
			"limit": "1",
			"passkey": "r538c65d7d3rsx2265tvzfje"
		},
		"client": "branddemo",
		"limit": 1,
		"productIds": [],
		"offset": 0,
		"display": [
			"livebv"
		],
		"filters": {},
		"featured": 0,
		"sortField": "authoredAt",
		"sortDirection": "desc"
	}
}