🚧

Only API keys on our Conversations PRR 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

Returns data about Content Authors.

Examples

🚧

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=kuy3zj9pr3n7i0wxajrzj04x

Requesting all authors who have written a review that has been recommended

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&include=reviews&filter_reviews=IsRecommended:eq:true

Requesting all authors who have written 20 or more comments

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=TotalCommentCount:gte:20

Requesting an author by ID

https://stg.api.bazaarvoice.com/data/authors.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=id:yums

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=kuy3zj9pr3n7i0wxajrzj04xo&filter=id:yums&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.

Parameters

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.

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.

Response format

This is an example response for a query listing Authors limiting the results to 1 entry and including statistics (average overall rating, rating distribution, secondary ratings averages, etc.) for reviews written by this author.

{
    "Includes": { },
    "HasErrors": false,
    "Offset": 0,
    "TotalResults": 36053,
    "Locale": "en_US",
    "Errors": [ ],
    "Results": [
        {
            "AdditionalFieldsOrder": [ ],
            "Avatar": { },
            "Photos": [ ],
            "ContextDataValues": {
                "age": {
                    "Value": "under21",
                    "ValueLabel": ""ReviewStatistics": {
                    "AverageOverallRating": 5,
                    "OverallRatingRange": 5,
                    "TotalReviewCount": 1
                    "RatingDistribution": [
                        {
                            "Count": 1,
                            "RatingValue": 2
                        },
                        {
                            "Count": 2,
                            "RatingValue": 3
                        }
                        {
                            "Count": 3,
                            "RatingValue": 5
                        }
                    ]
                }
            },
            "SecondaryRatingsAveragesOrder": [
                "Design",
                "Price",
                "RatingDimension3"
            ],
            "SecondaryRatingsAverages": {
                "RatingDimension3": {
                    "Id": "RatingDimension3",
                    "AverageRating": 1
                },
                "Price": {
                    "Id": "Price",
                    "AverageRating": 2
                },
                "Design": {
                    "Id": "Design",
                    "AverageRating": 3
                },
            }
            "SecondaryRatingsOrder": [ ],
            "UserNickname": "bfggbbd",
            "ProductRecommendationIds": [ ],
            "AdditionalFields": { },
            "SubmissionTime": "2012-03-01T05:58:03.000-00:00",
            "ModerationStatus": "APPROVED",
            "ReviewIds": [ ],
            "Id": "zzl7lx3wm8",
            "CommentIds": [ ],
            "SecondaryRatings": { },
            "LastModeratedTime": "2012-03-01T06:00:47.000-00:00"
        }
    ],
    "Limit": 1
}

Sample response for Errors:

{
    "Error": {
        "Code": "[ERROR_CODE]",
        "Message": "[ERROR_MESSAGE]"
    }
}

Response elements

Error codes