Retrieve Profiles

get

https://stg.api.bazaarvoice.com/data/authors.json

Profile/Authors Api is used to display about Author Information who have written reviews, questions and answers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

apiversion

number

required

The API version

passkey

string

required

API key is required to authenticate API user and check permission to access particular client's data.

Attributes

string

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.

Callback

string

Callback function name used with JSONP. Value is a string consisting of the following characters: a-z,A-Z,0-9,_ (excluding comma)

ExcludeFamily

boolean

Boolean flag indicating whether to exclude content from other products in the same family as the requested product.

Filter

array of strings

Filter criteria for primary content of the query. Multiple filter
criteria are supported. Here you can find few of many options we can use the filter parameter

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 .

Below we will be stating few examples of the filter parameter

Single Filter value: &filter=contextdatavalue_age:under21
Comma Seperated Multiple Filter values: &filter=ModeratorCode:eq:LI,PD
Multiple Filter AND'ed value: &filter=ContextDataValue_gender:eq:female&filter=ContextDataValue_age:eq:21to34&filter=.....

Filter

Filter_[TYPE]

string

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.

IncentivizedStats

boolean

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.

Include

string

Content types written by the author to be included (e.g. Questions, Reviews, Answers, or Comments).

Limit

integer

Max number of records returned. An error is returned if the value passed exceeds 100.

Limit_[TYPE]

integer

Limit option for a included content. TYPE can be Reviews, Questions, Answers or Comments. An error is returned if the value passed exceeds 20.

Locale

string

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.

Offset

integer

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.

Sort

array of strings

Ways to sort Authors

Sort criteria is specified as
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.

Below we will be stating few examples of the sort parameter

Single Sort value: &sort=Id:desc
Multiple Sort values AND'ed: &sort=Id:asc&sort=TotalReviewCount:desc

Sort

Sort_[TYPE]

string

Sort criteria for a included content. TYPE can be Reviews, Questions, Answers or Comments.

Stats

string

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.

Responses

200Successful response

400Bad Request

401Unauthorized Request

429Too Many Request Error

500Internal Server Error