Profile Display
Returns data about Content Authors.
Only API keys on our Conversations platform are eligible to use this API version. Refer to the Platforms section of our Platform & API Concepts documentation to learn which platform your API keys are on.
Try out Profile Display API reference here.
Examples
The following examples demonstrate common Conversations API display requests. For a complete overview of using the Conversations API to display data, refer to the Display tutorials.
Demonstration purposes only. Do not reuse the API passkeys below in your application.
Requesting all authors
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4
Requesting all authors who have written a review that has been recommended
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&include=reviews&filter_reviews=IsRecommended:eq:true
Requesting an author by ID
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=id:data-gen-user-poaouvr127us1ijhpafkfacb9
You can request for multiple authors by Id, by separating the Ids with a comma.
- e.g. filter=id:1234,4567,3456.
Requesting an author by ID along with questions and reviews written by author, sorted by submission time
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=id:data-gen-user-poaouvr127us1ijhpafkfacb9&include=reviews,questions&sort_reviews=submissiontime:desc&sort_questions=submissiontime:desc
The Reviews and Questions written by the Author can be filtered, sorted, and limited by specifying limit_reviews, limit_questions, sort_reviews, sort_questions, filter_reviews, filter_questions etc.
Requesting an author by Email address
When passing user email addresses as parameters in URLs within our system, it's imperative to encode these email addresses properly. URL encoding ensures that special characters within the email address, such as '+' or '/', are correctly interpreted by the server and prevents any unexpected behavior or security vulnerabilities.
Please contact Bazaarvoice support to enable email access on your API Key to make below request. Email address must be passed in an encrypted fashion. Refer to Encrypting Email Address for more details.
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=UserEmailAddress:5v7tb3uxb73esjJadxUI0sptTdVVsaZ2LISkxYoiJGg=
Requesting an author by Email address along with reviews, comments, questions and answers written by author
https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=UserEmailAddress:5v7tb3uxb73esjJadxUI0sptTdVVsaZ2LISkxYoiJGg=&include=reviews,questions,answers,comments
Parameters
| Name | Description | Required | Default Value |
|---|---|---|---|
ApiVersion |
The API version, e.g. 5.4. | Yes | |
[FORMAT] |
Response format (json) | Yes | |
PassKey |
API key is required to authenticate API user and check permission to access particular client's data. | Yes | |
Attributes |
Attributes to be included when returning content. For example, if includes are requested along with the &attributes=ModeratorCodes parameter, both the includes and the results will contain moderator codes. In order to filter by ModeratorCode, you must request the ModeratorCodes attribute parameter. | No | |
Callback |
Callback function name used with JSONP. Value is a string consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma). See the JSONP tutorial for more information. |
No | |
Filter |
Filter criteria for primary content of the query. Multiple filter criteria are supported. | No | |
Filter_[TYPE] |
Filter criteria for a included content or subject type. TYPE can be Reviews, Questions, Answers, or Comments. Multiple filter criteria are supported for each content type. | No | |
IncentivizedStats |
If set to true, displays the number of incentivized reviews written by each author returned in the response within an IncentivizedReviewCount element. This parameter must be used in conjunction with the FilteredStats or Stats parameters to include statistics for reviews in the response. |
No | false |
Include |
Content types written by the author to be included (e.g. Questions, Reviews, Answers, or Comments). | No | |
Limit |
Max number of records returned. An error is returned if the value passed exceeds 100. | No | 10 |
Limit_[TYPE] |
Limit option for a included content. TYPE can be Reviews, Questions, Answers or Comments. An error is returned if the value passed exceeds 20. | No | 10 |
Locale |
Locale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key. | No | |
Offset |
Index at which to return results. By default, indexing begins at 0 when you issue a query. Using Limit=100, Offset=0 returns results 0-99. When changing this to Offset=1, results 1-100 are returned. The maximum supported value is 300000. | No | 0 |
Sort |
Sort criteria for primary content type of the query. Sort order is required (asc or desc). Multi-attribute sorting for each content/subject type is supported. | No | |
Sort_[TYPE] |
Sort criteria for a included content. TYPE can be Reviews, Questions, Answers or Comments. | No | |
Stats |
The content types for which statistics should be calculated for the author. Available content types are: Reviews, Questions, Answers. Note: Statistics can also be calculated on includes. |
No |
Filter options
- Each filter argument specifies the attribute to filter on followed by a comma-separated list of values. For instance, "Filter=ModeratorCode:eq:LI,PD" will match all content with moderation code values of LI (Liability Concern) or PD (Product Description Inaccurate).
- Advanced operators can be used to define filters. For instance, "Filter=TotalReviewCount:gte:10" will match all content with a TotalReviewCount value of greater than or equal to 10. All advanced operators are documented on the Conversations API page.
- If a filter value contains a comma or a colon, that character needs to be escaped with a backslash (, or :). If a filter value contains an ampersand (&), the ampersand must be encoded in the filter value by replacing & with %26.
- Multiple filters are allowed as URL parameters in which case filters are AND'ed. For instance, "Filter=ContextDataValue_gender:eq:female&Filter=ContextDataValue_age:eq:21to34" will match all content written by women between the ages of 21 and 34.
- Time-based filters can be used for SubmissionTime and LastModeratedTime. Dates in time-based filters are calculated as the number of seconds since January 1, 1970, 00:00:00 UTC. In a future version, we will be adding support for comparing date/time string values. The following example returns content that was submitted on November 9, 2009: &filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800
The following table lists the attributes available for filtering.
| Name | Description |
|---|---|
Id |
The identifier of the Author.
|
AdditionalField_[FIELD_NAME] |
Additional field to filter by, e.g., filter=AdditionalField_[FIELD_NAME]:eq:[FIELD_VALUE]
|
ContentLocale |
Locale of the content to display. If this filter is not defined, all content regardless of its locale is returned. To return specific content by locale, define the value in the filter. A wildcard character “*” can be used to define the value, e.g., “en*” returns all content in English (en_US, en_CA, en_GB, etc.) or you can use a single ContentLocale code (e.g., “fr_FR”). ContentLocale codes are case-sensitive.
|
ContextDataValue_[DIMENSION_EXTERNAL_ID] |
The context data value for the content. DIMENSION_EXTERNAL_ID can be age, gender, etc. e.g. filter=contextdatavalue_age:under21
|
HasPhotos |
Boolean flag indicating whether the Author profile has photos.
|
HasVideos |
Boolean flag indicating whether the Author profile has videos. For more information on inserting the returned VideoUrl into HTML, see the Conversations API page.
|
LastModeratedTime |
The date/time of the latest moderation of the content. See the Introduction for an example of using advanced operators for filtering.
|
ModeratorCode |
String value indicating the moderator code for rejected content, e.g., &Filter=ModeratorCode:eq:CR returns UGC that contains the CR (Competitor Reference) code. Multiple codes can be entered in a comma-delimited list, e.g., &Filter=ModeratorCode:eq:CS,IU returns UGC with either the CS (Customer Service Complaint) or the IU (Inappropriate/Unusable Content) code. For a list of all Moderator Codes, see the Conversations API page. Note that the ModeratorCodes attribute parameter must be explicitly requested in order to use this filter. See the Parameters section above.
|
SubmissionTime |
The submission date/time of the content. See the Introduction for an example of using advanced operators for filtering.
|
TotalAnswerCount |
The number of Answers written by the Author.
|
TotalQuestionCount |
The number of Questions written by the Author.
|
TotalReviewCount |
The number of Reviews written by the Author.
|
UserLocation |
Location of the author
|
UserEmailAddress |
Encrypted Email of the author
Email address must be passed in an encrypted fashion to protect consumer privacy due to sensitive Personally Identifiable Information (PII). For a complete tutorial on encrypting email address, refer to the Encrypting Email Address. |
Sort options
- Sort criteria is specified as :asc for ascending and :desc for descending
- Multi-attribute sorting is supported by using a comma separated list of sort criteria for a content/subject type. For instance, Sort=TotalReviewCount:desc,Id:asc sorts the authors, first by their total review count (most to least), then if there are authors with the same number of reviews, the authors are sorted alphabetically by ID.
The following table lists the attributes that are available for sorting.
| Name | Description |
|---|---|
Id |
The identifier of the Author.
|
AdditionalField_[FIELD_NAME] |
Additional field to sort by, e.g., sort=AdditionalField_[FIELD_NAME]:desc
|
ContentLocale |
Locale value of the content
|
ContextDataValue_[DIMENSION_EXTERNAL_ID] |
The context data value for the content. DIMENSION_EXTERNAL_ID can be age, gender, etc. e.g. sort=contextdatavalue_age:desc
|
HasPhotos |
Boolean flag indicating whether the Author profile has photos.
|
HasVideos |
Boolean flag indicating whether the Author profile has videos. For more information on inserting the returned VideoUrl into HTML, see the Conversations API page.
|
LastModeratedTime |
The date/time of the latest moderation of the content
|
SubmissionTime |
The submission date/time of the content
|
TotalAnswerCount |
The number of Answers written by the Author.
|
TotalQuestionCount |
The number of Questions written by the Author.
|
TotalReviewCount |
The number of Reviews written by the Author.
|
UserLocation |
Location of the author
|
Response format
This is a sample response for requesting review comments. Use the links above to see live examples.
{
"Includes": { },
"HasErrors": false,
"Offset": 0,
"TotalResults": 224775,
"Locale": "en_US",
"Errors": [ ],
"Results": [
{...}
{...}
],
"Limit": 2
}
Response elements
| Name | Description |
|---|---|
Includes |
Included results related to primary results. For example, with the request
reviews.json?include=Comments, the Include node will be populated with comments associated with the reviews in the Results node.
|
HasErrors |
Boolean value indicated if one of more errors have occurred. See Errors below.
|
Offset |
Dataset offset used for pagination (passed as URL parameter in a query request). The maximum supported value is 300000.
|
TotalResults |
Total number of records matched.
|
Locale |
Indicates the language by region (language_region) associated with the client instance. This is the value used for field labels returned by the API, not the region from which the reviews originate.
|
Errors |
Error section is populated instead of other fields if there is an error with a query syntax or problem executing a query.
|
Results |
Section containing an array of primitive type object references matched by a query.
|
Limit |
The total number of results returned, specified by user in the URL. Defaults to 10 and has a maximum of 100.
|
Error codes
| Value | Description |
|---|---|
ERROR_ACCESS_DENIED |
Insufficient privileges to perform the operation |
ERROR_PARAM_INVALID_API_KEY |
Invalid API Key value |
ERROR_PARAM_INVALID_CALLBACK |
Invalid JsonP callback function name |
ERROR_PARAM_INVALID_FILTER_ATTRIBUTE |
Invalid filter attribute name |
ERROR_PARAM_INVALID_INCLUDED |
Invalid parameter value |
ERROR_PARAM_INVALID_LIMIT |
Invalid limit value |
ERROR_PARAM_INVALID_LOCALE |
Invalid locale code |
ERROR_PARAM_INVALID_OFFSET |
Invalid offset value |
ERROR_PARAM_INVALID_SORT_ATTRIBUTE |
Invalid sort attribute name |
ERROR_UNKNOWN |
Unknown error (internal server error, for instance) |
ERROR_UNSUPPORTED |
For unsupported features, clients etc. |
ERROR_PARAM_INVALID_PARAMETERS |
Something went wrong while processing the email id filter. |
ERROR_PARAM_ERROR_ACCESS_DENIED |
Email access is not enabled for passkey. |
By default, for all the form errors occurred during the API calls, the HTTPS response code 200 OK is returned, with the error information in the JSON response body.
curl --location 'https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4k&Filter=ProductId%3Adata-gen-moppq9ekthfzbc6qff3bqokie&Include=Products'
If the clients wish to receive 4xx, 5xx kind of error codes in HTTPS response, a small addition needs to be made to the api call. In the request header of the API call, add "bv-version" with value "5.4.1", this will generate appropriate 4xx, 5xx error codes in the HTTPS response. The JSON response still contains the detailed description of the error.
Example curl with header:
curl --location 'https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4k&Filter=ProductId%3Adata-gen-moppq9ekthfzbc6qff3bqokie&Include=Products' \
--header 'bv-version: 5.4.1'
Updated about 1 month ago