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

Analytics API

Contents:

In this documentation, you can find descriptions of the methods in the BrandWizard API for the Analytics section.

 

 

Method GET/public/v1/analytics/online_presence/data_completeness/

  • Description: Retrieve information about data completeness.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] Нет List of brand IDs
    company_ids array[integer] Нет List of company IDs
    date string Да Date

  • Response fields:

    Field Type Description
    average_score number Average synchronization rating
    categories number Number of categories
    phone_numbers number Number of phone numbers
    payment_methods number Number of payment methods
    logo number Number of logos
    cover number Number of company covers
    description number Number of company descriptions
    social_links number Number of social networks
    gallery number Number of gallery photos
    prices number Number of price lists
    posts number Number of posts

 

 

Method GET/public/v1/analytics/online_presence/double_gis/

  • Description: Retrieve online presence analytics from the 2GIS catalog.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    company_ids array[integer] No List of company IDs
    end_date string No End date of the requested period
    start_date string Yes Start date of the requested period

  • Response fields:

    Field Type Description
    result key string Date from the requested period
    open_card_discovery integer Card opened when user found organization via category/service search
    open_card_recovery integer Card opened when user found company by its name
    open_photo_gallery integer Photo gallery opened
    open_socials integer Clicks to social networks
    build_route integer Routes built
    impressions integer Card impressions
    click_site integer Website visits
    actions_phone integer Phone calls from card
    status string
    • OK
    • something_went_wrong
    • access_denied

 

 

Method GET/public/v1/analytics/online_presence/qa/

  • Description: Retrieve data from the Questions & Answers section.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    company_ids array[integer] No List of company IDs
    end_date string No End date of the requested period
    start_date string Yes Start date of the requested period

  • Response fields:

    Field Type Description
    result answer_count integer Number of answered questions
    no_answer_count integer Number of unanswered questions
    status string
    • OK
    • something_went_wrong
    • access_denied

 

 

Method GET/public/v1/analytics/online_presence/reviews/

  • Description: Retrieve review analytics.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    catalogs array[integer] No List of catalogs
    company_ids array[integer] No List of company IDs
    end_date string No End date of the requested period
    start_date string Yes Start date of the requested period

  • Response fields:

    Field Type Description
    result date string Date for which reviews were received
    count integer Number of reviews
    with_answer_count integer Number of reviews with a reply
    nps integer Net Promoter Score (positivity index)
    status string
    • OK
    • something_went_wrong
    • access_denied

 

 

Method GET/public/v1/analytics/online_presence/sync/

  • Description: Retrieve synchronization data.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    catalogs array[integer] No List of catalogs
    company_ids array[integer] No List of company IDs
    date string Yes Date

  • Response fields:

    Field Type Description
    result sync_avg number Average synchronization percentage across all services
    maps id integer Catalog ID
    name string Catalog name
    sync_avg integer Average synchronization percentage for catalog
    navigators id integer Catalog ID
    name string Catalog name
    status string
    • OK
    • something_went_wrong
    • access_denied

 

 

Method GET/public/v1/analytics/online_presence/sync/company/

  • Description: Retrieve basic synchronization info (only for companies in company_ids; brand_ids will be ignored).

  • Request parameters:

    Parameter Type Required? Description
    catalogs array[integer] No List of catalogs
    company_ids array[integer] No List of company IDs
    date string Yes Date

  • Response fields:

Field Type Description
result sync_avg number Average synchronization percentage across all services
maps id integer Catalog ID
name string Catalog name
sync_avg integer Average synchronization percentage for catalog
navigators id integer Catalog ID
name string Catalog name
status string
  • OK
  • something_went_wrong
  • access_denied

 

 

Method GET/public/v1/analytics/online_presence/yandex/additional/

  • Description: Retrieve additional Yandex analytics data.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    company_ids array[integer] No List of company IDs
    end_date string No End date of the requested period
    start_date string Yes Start date of the requested period

  • Response fields:

    Field Type Description
    verified_by_owner_percentage integer Percentage of companies verified by owner
    profile_fullness_percentage integer Profile completeness percentage
    photos_count integer Number of photos
    heading_position integer Presence of heading
    heading_diff integer Heading differences
    sources result poi integer Impressions in search results (by name/category)
    text_search_on_map integer Clicks via text search on map
    suggest_search_on_map integer Clicks via map suggestions
    status string
    • OK
    • something_went_wrong
    • access_denied
    services result navi integer Actions in Yandex.Navigator app
    mobile_maps integer Actions in Yandex.Maps mobile version
    desktop_maps integer Actions in Yandex.Maps desktop version
    status string
    • OK
    • something_went_wrong
    • access_denied

 

 

Method GET/public/v2/analytics/online_presence/companies/

  • Description: Retrieve analytics data for companies.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    company_ids array[integer] No List of company IDs
    end_date string No End date of the requested period
    start_date string Yes Start date of the requested period

     

  • Response fields:

    Field Type Description
    count integer Number of results
    companies company_id integer Company ID
    company_name string Company name
    company_address string Company address
    catalogs catalog string Catalog
    conversion number Conversion
    impressions integer Number of impressions
    call_clicks integer Number of calls
    website_clicks integer Number of website visits
    direction_requests integer Number of routes built
    other integer Others

 

 

Method GET/public/v2/analytics/online_presence/data_completeness/

  • Description: Retrieve data completeness analytics.

  • Request parameters:

    Parameter Type Required? Description
    brand_ids array[integer] No List of brand IDs
    company_ids array[integer] No List of company IDs
    date string Yes Date

     

  • Response fields:

    Field Type Description
    result average_score array[integer] Average percentage of synchronization across services
    enough_phones array[integer] Indicates whether sufficient phone numbers are provided
    enough_payments_methods array[integer] Indicates whether sufficient payment methods are provided
    enough_categories array[integer] Indicates whether sufficient categories are provided
    has_logo array[integer] Whether a company logo is available
    has_cover array[integer] Whether a company cover image is available
    has_description array[integer] Whether a company description is available
    vk_exists array[integer] Indicates if VK is accessible
    social_links service string

    List of supported services:

    • viber
    • whatsap
    • yandex_ze
    • telegram
    • linked_in
    • instagram
    • ok_ru
    • google_plus
    • youtube
    • twitter
    • vk
    • facebook
    • tiktok
    percentage number Formula: (number of social networks * 100) / number of companies
    has_gallery array[integer] Whether a photo gallery is available
    has_yandex_price array[integer] Whether product prices are available in Yandex
    has_google_price array[integer] Whether product prices are available in Google
    yandex_verified_by_owner array[integer] Indicates if the company is verified by the owner in Yandex
    yandex_exists array[integer] Indicates if Yandex is accessible
    on_date string Date of the record
    status string
    • OK
    • something_went_wrong
    • access_denied

 

Method GET/public/v2/analytics/online_presence/double_gis/

  • Description: Retrieve analytics from the 2GIS catalog.

  • Request parameters:

    Parameter Type Required? Description
    brand_id integer Да Brand ID
    company_ids array[integer] Нет List of company IDs
    end_date string Нет End date of the period for which data is retrieved
    group_by string Нет Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string Нет Start date of the period for which data is retrieved

  • Response fields:

    Field Type Description
    items direct_queries_count integer Number of direct queries for a specific company
    total_queries_count integer Total number of queries for a specific company
    routes_count integer Number of routes for a specific company
    phone_clicks_count integer Number of phone clicks for a specific company
    website_clicks_count integer Number of website visits for a specific company
    photo_views_count integer Number of photo views for a specific company
    social_clicks_count integer Number of social media clicks for a specific company
    cta_clicks_count integer Number of calls to action for a specific company
    impressions_count integer Number of impressions for a specific company
    date start string Start date
    end string End date
    summary direct_queries_count integer Total number of direct queries for all companies
    total_queries_count integer Total number of queries for all companies
    routes_count integer Total number of routes for all companies
    phone_clicks_count integer Total number of phone clicks for all companies
    website_clicks_count integer Total number of website visits for all companies
    photo_views_count integer Total number of photo views for all companies
    social_clicks_count integer Total number of social media clicks for all companies
    cta_clicks_count integer Total number of calls to action for all companies
    impressions_count integer Total number of impressions for all companies
    base_indicators impressions integer Impressions
    interactions integer Target actions
    conversion integer Conversion
    meta total integer Total number of records (items)

 

 

Method GET/public/v2/analytics/online_presence/facebook/

  • Description: Retrieve analytics from Facebook.

  • Request parameters:

    Parameter Type Required? Description
    brand_id integer Да Brand ID
    company_ids array[integer] Нет List of company IDs
    end_date string Нет End date of the requested period
    group_by string Нет Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string Нет Start date of the requested period
  • Response fields:
Field Type Description
items impressions_count integer Number of impressions for a specific company
call_clicks_count integer Number of phone call clicks for a specific company
website_clicks_count integer Number of website visits for a specific company
direction_requests_count integer Number of routes built to a specific company
date start string Start date of the period for which data is retrieved
end string End date of the period for which data is retrieved
summary impressions_count integer Total number of impressions for all companies
call_clicks_count integer Total number of phone call clicks for all companies
website_clicks_count integer Total number of website visits for all companies
direction_requests_count integer Total number of routes built for all companies
base_indicators impressions integer Impressions
interactions integer Target actions
conversion integer Conversion
meta total integer Total number of records (items)

 

 

Method GET/public/v2/analytics/online_presence/gmb/

  • Description: Retrieve analytics from Google My Business.

  • Request parameters:

    Parameter Type Required? Description
    brand_id integer Да Brand ID
    company_ids array[integer] Нет List of company IDs
    end_date string Нет End date of the requested period
    group_by string Нет Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string Нет Start date of the requested period
  • Response fields:
Field Type Description
items desktop_maps_business_impressions_count integer Number of impressions for a specific company in maps on desktop devices
mobile_maps_business_impressions_count integer Number of impressions for a specific company in maps on mobile devices
desktop_search_business_impressions_count integer Number of impressions for a specific company in search on desktop devices
mobile_search_business_impressions_count integer Number of impressions for a specific company in search on mobile devices
business_conversations_count integer Number of website visits for a specific company
business_bookings_count integer Number of bookings for a specific company
business_food_orders_count integer Number of orders for a specific company
business_direction_requests_count integer Number of routes built to a specific company
call_clicks_count integer Number of phone call clicks for a specific company
website_clicks_count integer Number of website clicks for a specific company
date start string Start date of the period for which data is retrieved
end string End date of the period for which data is retrieved
summary desktop_maps_business_impressions_count integer Total impressions across all companies in maps on desktop devices
mobile_maps_business_impressions_count integer Total impressions across all companies in maps on mobile devices
desktop_search_business_impressions_count integer Total impressions across all companies in search on desktop devices
mobile_search_business_impressions_count integer Total impressions across all companies in search on mobile devices
business_conversations_count integer Total website visits across all companies
business_bookings_count integer Total bookings across all companies
business_food_orders_count integer Total orders across all companies
business_direction_requests_count integer Total routes built across all companies
call_clicks_count integer Total call clicks across all companies
website_clicks_count integer Total website clicks across all companies
base_indicators impressions integer Impressions
interactions integer Target actions
conversion integer Conversion
meta total integer Total number of records (items)

 

 

Method GET/public/v2/analytics/online_presence/main_metrics/

  • Description: Retrieve main metrics analytics.

  • Request parameters:

    Parameter Type Required? Description
    brand_id integer Да Brand ID
    company_ids array[integer] Нет List of company IDs
    end_date string Нет End date of the requested period
    group_by string Нет Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string Нет Start date of the requested period
  • Response fields:
Field Type Description
items impressions_count integer Number of impressions for a specific company
website_clicks_count integer Number of website visits for a specific company
call_views_count integer Number of phone calls for a specific company
direction_requests_count integer Number of routes built for a specific company
other integer Others
date start string Start date of the period for which data is retrieved
end string End date of the period for which data is retrieved
summary impressions_count integer Total number of impressions for all companies of the brand
website_clicks_count integer Total number of website visits for all companies
call_views_count integer Total number of phone calls for all companies
direction_requests_count integer Total number of routes built for all companies
other integer Others
base_indicators impressions integer Impressions
interactions integer Target actions
conversion integer Conversion
meta total integer Total number of records (items)

 

 

Method GET/public/v2/analytics/online_presence/search_phrases/

  • Description: Retrieving analytics data by search phrases.

  • Request parameters:

     

    Parameter Type Required? Description
    brand_id integer Yes Brand ID
    company_ids array[integer] No List of company IDs
    end_date string No End date of the period for which data is retrieved
    group_by string No Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string No Start date of the period for which data is retrieved

  • Response fields:

    Field Type Description
    result search_phrase string Search phrase
    value integer Total number of events (impressions/clicks) for the phrase over the entire period
    values_by_catalog catalog_id integer Catalog identifier
    value integer Number of events for the phrase in this catalog
    dynamic_values integer Dynamics of the total number of events for the phrase over the period
    dynamic_values_by_catalog catalog_id integer Catalog identifier
    value integer Dynamics of the total number of events for the phrase in this catalog
    dynamic_labels string Selected date range

 

 

Method GET/public/v2/analytics/online_presence/yandex/

  • Description: Retrieving analytics data for Yandex.

  • Request parameters:

     

    Parameter Type Required? Description
    brand_id integer Yes Brand ID
    company_ids array[integer] No List of company IDs
    end_date string No End date of the period for which data is retrieved
    group_by string No Grouping of statistical data.
    Available values : day, month, week
    Default value : month
    start_date string No Start date of the period for which data is retrieved

  • Response fields:

    Field Type Description
    items total_queries_count integer Number of impressions for a specific company
    routes_count integer Number of routes built to a specific company
    phone_clicks_count integer Number of phone clicks for a specific company
    website_clicks_count integer Number of website clicks for a specific company
    whatsapp integer Number of transitions to WhatsApp from a specific company
    viber integer Number of transitions to Viber from a specific company
    telegram integer Number of transitions to Telegram from a specific company
    wechat integer Number of transitions to WeChat from a specific company
    stories integer Number of clicks in stories of a specific company
    date start string Start date
    end string End date
    summary total_queries_count integer Total number of impressions for all companies
    routes_count integer Total number of routes built for all companies
    phone_clicks_count integer Total number of phone clicks for all companies
    website_clicks_count integer Total number of website clicks for all companies
    whatsapp integer Total number of transitions to WhatsApp for all companies
    viber integer Total number of transitions to Viber for all companies
    telegram integer Total number of transitions to Telegram for all companies
    wechat integer Total number of transitions to WeChat for all companies
    stories integer Total number of clicks in stories for all companies
    base_indicators impressions integer Impressions
    interactions integer Target actions
    conversion integer Conversion
    meta total integer Total number of records (items