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

Analytics reviews API

In this documentation, you can familiarize yourself with the description of the RocketData API methods for the Review Analytics section.

 

 

Method POST/public/v1/analytics/reviews/analytics_delta/export_table/

  • Description: Get card ratings in catalogs. The data is taken from the export in the Card Rating section of the personal account.
  • Request Parameters:
    Parameter Type Required? Description
    filter type string Yes

    Filter type:

    • companyIds – by list of company IDs
    • brandId – by brand ID
    • storeCodes – by list of store codes
    company_ids integer No List of company IDs
    brand_id integer No Brand ID
    store_codes string No List of store codes
    date_from string No Start date of the period for which data is exported
    date_to string No End date of the period for which data is exported
    page integer No Page number within the pagination result set
    page_size integer No Number of objects per page (from 1 to 100, default 50)
  • Response Fields:
Field Type Description
result pagination page integer Page number within the pagination result set
page_size integer Number of objects per page (1–100, default 50)
count integer Total number of companies matching the filter
company_count integer Same as count; kept for backward compatibility with older clients
period date_from string Start date of the data export period
date_to string End date of the data export period
period_dates string Each calendar day in the range [date_from, date_to], inclusive
ratings_average - Average card rating for each catalog: Yandex, Google, 2GIS.
results - Company rows on this page in export format.
One location rating export row: brand, address, ratings/NPS/catalog links, same columns as in XLSX/CSV export (plus company_id).
status string
  • OK
  • something_went_wrong
  • access_denied