Skip to content
English
Go to brandwizard.io
  • There are no suggestions because the search field is empty.

Reviews v4 API

Contents:

In this documentation, you can find a description of the methods of the BrandWizard API in the Reviews v4 section.

 

 

Method GET/public/v4/reviews/

  • Description: Get a list of review objects.
  • Request Parameters:
Parameter Type Required? Description
action_abuse boolean No Whether complaints can be submitted for reviews: Yes/No
action_reply boolean No Whether replies are possible: Yes/No
all_responsible_users string No All responsible employees
brand_ids list[integer] No List of brand IDs
catalog_ids list[integer] No List of catalog IDs
city_ids list[integer] No List of city IDs
company_group_ids list[integer] No List of company group IDs
company_ids list[integer] No List of company IDs
created_at_gt string No Reviews created after the provided date
cursor string No Set cursor for returning results
date_gte string No Show reviews from this date
date_lte string No Show reviews up to this date
has_abuse boolean No Whether complaints were submitted via BrandWizard cabinet: Yes/No
has_changes boolean No Whether the review was changed: Yes/No
in_trash boolean No Whether the review was deleted: Yes/No
is_replied boolean No With reply / without reply: Yes/No
moderated boolean No Whether the review passed moderation: Yes/No
per_page integer No Number of results per page
process_status list[integer] No Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted
rating list[integer] No Ratings (if not specified, pass 0)
rating_type string No Review type by rating: positive, negative, neutral
replier_ids list[integer] No List of BrandWizard employees who replied
responsible_users list[integer] No Employees responsible for processing the review
target string No Reviews on brand / reviews on company
without_text boolean No With text / without text: Yes/No

  • Response Fields:

    Field Type Description
    next string Link to the next page
    previous string Link to the previous page
    per_page integer Number of results per page
    results author string Review author’s name
    created_in_catalog string Date created in catalog
    created_in_rd string Date created in BrandWizard cabinet
    parsed_at string Date review collected into cabinet
    comment string Review text
    deleted_at string Deletion date
    able_to_reply boolean Ability to reply: Yes/No
    id integer Review ID
    rating number Rating
    origin_url string Link to review in catalog
    location_url string Link to location in catalog
    able_to_abuse boolean Ability to submit complaint: Yes/No
    abuse_last_date string Date of last complaint submission
    is_changed boolean Review changed: Yes/No
    tags relation_id integer Tag relation ID with review
    id integer Tag ID
    title string Tag name
    is_aspect boolean Is aspect: Yes/No (see more details here)
    folder_id integer Tag group ID
    catalog_id integer Catalog ID
    company id integer Company ID
    name string Company name
    code string Branch code
    address country string Country where the company is located
    country_code string Country code
    region string Region
    city string City
    street string Street
    housenumber string House number
    postcode string Postal code
    brand id integer Brand ID
    name string Brand name
    process_status list[integer] Review processing status: processed; not_processed; coordination; in_process; decided; request_info; bonus_provided; answer_in_catalog; abuse_sent; review_deleted; review_changed
    able_to_change_responsible_user boolean Ability to change responsible employee: Yes/No
    responsible_user id integer Responsible employee ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    user_fields string Additional information (e.g., email)
    notes id integer Note ID
    text string Note text
    created_at string Note creation date
    updated_at string Note update date
    user id integer Employee ID who created the note
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    children author string Reply author
    created_in_catalog string Reply creation date in catalog
    created_in_rd string Reply creation date in BrandWizard cabinet
    parsed_at string Date reply collected into cabinet
    comment string Reply text
    deleted_at string Reply deletion date
    able_to_reply boolean Ability to reply: Yes/No
    type string Reply type (reply/command)
    reply_id integer Reply ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; reply_id is filled when reply is collected from catalog and saved in BrandWizard DB)
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when reply can be edited for secondary catalogs
    last_changes_date string Date of last reply change
    additional_author_name string Reviewer's name. Filled in when the review is received from the Review Generator; in other cases, the field will be empty.
    additional_author_email string Reviewer's email. Filled in when the review is received from the Review Generator; in other cases, the field will be empty.
    additional_author_phone string Reviewer's phone number. Filled in when the review is received from the Review Generator; in other cases, the field will be empty.

 

 

Method POST/public/v4/reviews/{id}/abuse/

  • Description: Complain about the review. Specify a unique identifier (id) and reason in the body of the request (reason).
  • Request Parameters:
Parameter Type Required? Description
id string Yes Review ID
  • Request body:
Field Type Description
reason string Complaint reason

  • Response Fields:

    Field Type Description
    id integer Complaint ID
    review_id integer Review ID
    reason string Complaint reason

 

 

Method PUT/public/v4/reviews/{review_id}/commands/{command_id}/

  • Description: Edit reply (if reply is not delivered yet).
  • Request Parameters:
Parameter Type Required? Description
command_id string Yes Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
review_id string Yes Review ID
  • Request body:
Field Type Description
comment string Reply text

  • Response Fields:

    Field Type Description
    reply_id string Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously. The reply_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database).
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    type string Reply type (reply/command)
    author string Reply author
    comment string Reply text
    created_in_rd string Reply creation date in BrandWizard cabinet
    created_in_catalog string Reply creation date in catalog
    parsed_at string Date reply collected from catalog into cabinet
    deleted_at string Reply deletion date
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_reply boolean Ability to reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    children - List of replies to the review reply
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs

 

 

Method DELETE/public/v4/reviews/{review_id}/commands/{command_id}/

  • Description: Delete reply (if reply is not delivered yet or reply has undelivered changes).

  • Request Parameters:

    Parameter Type Required? Description
    command_id string Yes Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    review_id string Yes Review ID

  • Response Fields:

    Field Type Description
    reply_id string Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously. The reply_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database).
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    type string Reply type (reply/command)
    author string Reply author
    comment string Reply text
    created_in_rd string Reply creation date in BrandWizard cabinet
    created_in_catalog string Reply creation date in catalog
    parsed_at string Date reply collected from catalog into cabinet
    deleted_at string Reply deletion date
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_reply boolean Ability to reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    children - List of replies to the review reply
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name> string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs

 

 

Method PUT/public/v4/reviews/{review_id}/replies/{reply_id}/

  • Description: Edit reply (if reply is already delivered).

  • Request Parameters:

    Parameter Type Required? Description
    reply_id string Yes Reply ID
    review_id string Yes Review ID

  • Request body:

    Field Type Description
    comment string Reply text

  • Response Fields:

    Field Type Description
    reply_id string Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously. The reply_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database).
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    type string Reply type (reply/command)
    author string Reply author
    comment string Reply text
    created_in_rd string Reply creation date in BrandWizard cabinet
    created_in_catalog string Reply creation date in catalog
    parsed_at string Date reply collected from catalog into cabinet
    deleted_at string Reply deletion date
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_reply boolean Ability to reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    children - List of replies to the review reply
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs

 

 

Method DELETE/public/v4/reviews/{review_id}/replies/{reply_id}/

  • Description: Delete reply (if reply is already delivered).

  • Request Parameters:

    Parameter Type Required? Description
    reply_id string Yes Reply ID
    review_id string Yes Review ID

  • Response Fields:

    Field Type Description
    reply_id string Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously. The reply_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database).
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    type string Reply type (reply/command)
    author string Reply author
    comment string Reply text
    created_in_rd string Reply creation date in BrandWizard cabinet
    created_in_catalog string Reply creation date in catalog
    parsed_at string Date reply collected from catalog into cabinet
    deleted_at string Reply deletion date
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_reply boolean Ability to reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    children - List of replies to the review reply
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name< string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs

 

 

Method POST/public/v4/reviews/{review_id}/reply/

  • Description: Respond to a review using a unique review ID.

  • Request Parameters:

    Parameter Type Required? Description
    review_id string Yes Review ID

  • Request body:

    Field Type Description
    comment string Reply text

  • Response Fields:

    Field Type Description
    reply_id string Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously. The reply_id field will be filled when the reply is collected from the catalog and saved in the BrandWizard database).
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    type string Reply type (reply/command)
    author string Reply author
    comment string Reply text
    created_in_rd string Reply creation date in BrandWizard cabinet
    created_in_catalog string Reply creation date in catalog
    parsed_at string Date reply collected from catalog into cabinet
    deleted_at string Reply deletion date
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_reply boolean Ability to reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    children - List of replies to the review reply
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs

 

 

Method PATCH/public/v4/reviews/{review_id}/status/

  • Description: Change process_status of review.

  • Request Parameters:

    Parameter Type Required? Description
    review_id string Yes Review ID

  • Request body:

    Field Type Description
    process_status list[integer] Review processing status: processed; not_processed; coordination; in_process; decided; request_info; bonus_provided; answer_in_catalog; abuse_sent; review_deleted; review_changed
  • Response Fields: None.

 

 

Method POST/public/v4/reviews/custom_reviews/

  • Description: Create a custom review object.
  • Request Parameters: None.

  • Request body:

    Field Type Description
    brand_id integer Brand ID
    origin_url string Customer review link
    company_id integer Company ID
    catalog_id integer Catalog ID
    creation_time string Creation date
    author string Author’s name
    phone string Author’s phone number
    comment string Review text
    rating integer Review rating
    user_fields - Additional information can be specified here, for example email
    tag_ids integer Tag IDs
    notes text string Note text

  • Response Fields:

    Field Type Description
    author string Review author’s name
    created_in_catalog string Date created in catalog
    created_in_rd string Date created in BrandWizard cabinet
    parsed_at string Date review collected into cabinet
    comment string Review text
    deleted_at string Deletion date
    able_to_reply boolean Ability to reply: Yes/No
    id integer Review ID
    rating number Rating
    origin_url string Link to review in catalog
    location_url string Link to location in catalog
    able_to_abuse boolean Ability to submit complaint: Yes/No
    abuse_last_date string Date of last complaint submission
    is_changed boolean Review changed: Yes/No
    tags relation_id integer Tag relation ID with review
    id integer Tag ID
    title string Tag name
    is_aspect boolean Is aspect: Yes/No (see more details here)
    folder_id integer Tag group ID
    catalog_id integer Catalog ID
    company id integer Company ID
    name string Company name
    code string Branch code
    address country string Country where the company is located
    country_code string Country code
    region string Region
    city string City
    street string Street
    housenumber string House number
    postcode string Postal code
    brand id integer Brand ID
    name string Brand name
    process_status list[integer] Review processing status: processed; not_processed; coordination; in_process; decided; request_info; bonus_provided; answer_in_catalog; abuse_sent; review_deleted; review_changed
    able_to_change_status boolean Ability to change status: Yes/No
    able_to_change_responsible_user boolean Ability to change responsible employee: Yes/No
    responsible_user id integer Responsible employee ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    user_fields string Additional information (e.g., email)
    reply_time_in_catalog integer Reply time in catalog
    reply_time_in_rd integer Reply time in BrandWizard cabinet
    moderated boolean Reply verified: Yes/No
    children author string Reply author
    created_in_catalog string Reply creation date in catalog
    created_in_rd string Reply creation date in BrandWizard cabinet
    parsed_at string Date reply collected from catalog into cabinet
    comment string Reply text
    deleted_at string Reply deletion date
    able_to_reply boolean Ability to reply: Yes/No
    type string Reply type (reply/command)
    reply_id integer Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously; reply_id is filled when reply is collected from catalog and saved in BrandWizard DB)
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs
    status string

    Command delivery status: 

    • init_status (initial state);
    • sent_status (reply successfully sent); 
    • delivered_status (reply collected from catalog); 
    • permission_problem_status (no access or rights); 
    • review_not_found_status (review deleted or unavailable in catalog); 
    • exception_status (failed to send); 
    • cancelled_status (reply no longer required); 
    • outdated_status (command no longer relevant); 
    • moderation_failed_status (reply moderation failed); 
    • resend_status (command must be resent to catalog).
    action string Action type: create/edit/delete
    last_changes_date string Date of last reply change
    last_changes_date string Date of last review change
    notes string Note on review

 

 

Method PATCH/public/v4/reviews/custom_reviews/{id}/

  • Description: Update a custom review object.

  • Request Parameters:

    Parameter Type Required? Description
    id string Yes Custom review ID

  • Request body:

    Field Type Description
    brand_id integer Brand ID
    origin_url string Customer review link
    company_id integer Company ID
    catalog_id integer Catalog ID
    creation_time string Creation date
    author string Author’s name
    phone string Author’s phone number
    comment string Review text
    rating integer Review rating
    user_fields - Additional information can be specified here, for example email
    tag_ids integer Tag IDs
    notes id integer Note ID
    text string Note text

  • Response Fields:

    Field Type Description
    author string Review author’s name
    created_in_catalog string Date created in catalog
    created_in_rd string Date created in BrandWizard cabinet
    parsed_at string Date review collected into cabinet
    comment string Review text
    deleted_at string Deletion date
    able_to_reply boolean Ability to delete: Yes/No
    id integer Review ID
    rating number Rating
    origin_url string Link to review in catalog
    location_url string Link to location in catalog
    able_to_abuse boolean Ability to submit complaint: Yes/No
    abuse_last_date string Date of last complaint submission
    is_changed boolean Review changed: Yes/No
    tags relation_id integer Tag relation ID with review
    id integer Tag ID
    title string Tag name
    is_aspect boolean Is aspect: Yes/No (see more details here)
    folder_id integer Tag group ID
    catalog_id integer Catalog ID
    company id integer Company ID
    name string Company name
    code string Branch code
    address country string Country where the company is located
    country_code string Country code
    region string Region
    city string City
    street string Street
    housenumber string House number
    postcode string Postal code
    brand id integer Brand ID
    name string Brand name
    process_status list[integer] Review processing status: processed; not_processed; coordination; in_process; decided; request_info; bonus_provided; answer_in_catalog; abuse_sent; review_deleted; review_changed
    able_to_change_status boolean Ability to change status: Yes/No
    able_to_change_responsible_user boolean Ability to change responsible employee: Yes/No
    responsible_user id integer Responsible employee ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    user_fields string Additional information (e.g., email)
    reply_time_in_catalog integer Reply time in catalog
    reply_time_in_rd integer Reply time in BrandWizard cabinet
    moderated boolean Reply verified: Yes/No
    children author string Reply author
    created_in_catalog string Reply creation date in catalog
    created_in_rd string Reply creation date in BrandWizard cabinet
    parsed_at string Date reply collected from catalog into cabinet
    comment string Reply text
    deleted_at string Reply deletion date
    able_to_reply boolean Ability to reply: Yes/No
    type string Reply type (reply/command)
    reply_id integer Reply ID in BrandWizard (fields reply_id and command_id cannot be filled simultaneously; reply_id is filled when reply is collected from catalog and saved in BrandWizard DB)
    command_id integer Command ID in BrandWizard (reply_id and command_id cannot be filled simultaneously; command_id is filled when user writes a reply and sends it via API (https://api.brandwizard.io/public/swagger-ui/#/Reviews%20v4/v4_reviews_reply_create) or BrandWizard cabinet; once reply is published and collected, command_id becomes empty and reply_id is displayed)
    is_company_comment boolean Official company reply: Yes/No
    is_autoreply boolean Auto reply: Yes/No
    able_to_edit boolean Ability to edit reply: Yes/No
    able_to_delete boolean Ability to delete reply: Yes/No
    user id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee
    editable_until string Shows until when the reply can be edited for secondary catalogs
    status string

    Command delivery status: 

    • init_status (initial state);
    • sent_status (reply successfully sent); 
    • delivered_status (reply collected from catalog); 
    • permission_problem_status (no access or rights); 
    • review_not_found_status (review deleted or unavailable in catalog); 
    • exception_status (failed to send); 
    • cancelled_status (reply no longer required); 
    • outdated_status (command no longer relevant); 
    • moderation_failed_status (reply moderation failed); 
    • resend_status (command must be resent to catalog).
    action string Action type: create/edit/delete
    last_changes_date string Date of last reply change
    last_changes_date string Date of last review change
    notes string Note on review

 

 

Method DELETE/public/v4/reviews/custom_reviews/{id}/

  • Description: Delete a custom review object.

  • Request Parameters:

    Parameter Type Required? Description
    id string Yes Custom review ID
  • Response Fields: None.

 

 

Method GET/public/v4/reviews/repliers/

  • Description: Get a list of users who have responded to reviews.

  • Request Parameters:

    Parameter Type Required? Description
    action_abuse boolean No Whether complaints can be submitted for reviews: Yes/No
    action_reply boolean No Whether replies are possible: Yes/No
    all_responsible_users string No All responsible employees
    brand_ids list[integer] No List of brand IDs
    catalog_ids list[integer] No List of catalog IDs
    city_ids list[integer] No List of city IDs
    company_group_ids list[integer] No List of company group IDs
    company_ids list[integer] No List of company IDs
    created_at_gt string No Reviews created after the provided date
    date_gte string No Show reviews from this date
    date_lte string No Show reviews up to this date
    has_abuse boolean No Whether complaints were submitted via BrandWizard cabinet: Yes/No
    has_changes boolean No Whether the review was changed: Yes/No
    in_trash boolean No Whether the review was deleted: Yes/No
    is_replied boolean No With reply / without reply: Yes/No
    moderated boolean No Whether the review passed moderation: Yes/No
    process_status list[string] No Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted
    rating list[integer] No Ratings (if not specified, pass 0)
    rating_type string No Review type by rating: positive, negative, neutral
    replier_ids list[integer] No List of BrandWizard employees who replied
    responsible_users list[integer] No Employees responsible for processing the review
    target string No Reviews on brand / reviews on company
    without_text boolean No With text / without text: Yes/No

  • Response Fields:

    Field Type Description
    results id integer User ID
    email string Employee email
    first_name string First name
    last_name string Last name
    full_name string Full name
    is_agency boolean Responsible user is a BrandWizard agency employee

 

 

Method GET/public/v4/reviews/statistic/

  • Description: Get statistics on reviews.

  • Request Parameters:

    Parameter Type Required? Description
    action_abuse boolean No Whether complaints can be submitted for reviews: Yes/No
    action_reply boolean No Whether replies are possible: Yes/No
    all_responsible_users string No All responsible employees
    brand_ids list[integer] No List of brand IDs
    catalog_ids list[integer] No List of catalog IDs
    city_ids list[integer] No List of city IDs
    company_group_ids list[integer] No List of company group IDs
    company_ids list[integer] No List of company IDs
    created_at_gt string No Reviews created after the provided date
    date_gte string No Show reviews from this date
    date_lte string No Show reviews up to this date
    has_abuse boolean No Whether complaints were submitted via BrandWizard cabinet: Yes/No
    has_changes boolean No Whether the review was changed: Yes/No
    in_trash boolean No Whether the review was deleted: Yes/No
    is_replied boolean No With reply / without reply: Yes/No
    moderated boolean No Whether the review passed moderation: Yes/No
    process_status list[string] No Review processing status: Processed; Not processed; Coordination; In process; Decided; Request information from client; Bonus provided to client; Answer given via catalog; Complaint submitted; Review deleted
    rating list[integer] No Ratings (if not specified, pass 0)
    rating_type string No Review type by rating: positive, negative, neutral
    replier_ids list[integer] No List of BrandWizard employees who replied
    responsible_users list[integer] No Employees responsible for processing the review
    target string No Reviews on brand / reviews on company
    without_text boolean No With text / without text: Yes/No

  • Response Fields:

    Field Type Description
    count integer Number of reviews
    negative integer Number of negative reviews
    neutral integer Number of neutral reviews
    positive integer Number of positive reviews
    rating_avg number Average rating