Grabo Partners API  »  API Nodes  »  profiles

Profiles

Информация за Вашите бизнес профили (профили в секцията Места) в Grabo.bg.

Функции:
  • profiles/list: Връща списък с Вашите бизнес профили.
  • profiles/get_deals: Връща офертите към конкретен Ваш бизнес профил.
  • profiles/get_reviews: Връща потребителските ревюта към конкретен Ваш бизнес профил.
  • » Функция profiles/list

    Връща списък с Вашите бизнес профили в Grabo.bg.

    Request URL:
    https://grabo.bg/api/partners/profiles/list/?api_key={api_key}&company_id={company_id}
    Примерен отговор:
    { "success": true, "error": false, "result": [ // ... ] }
    Полето result е масив, съдържащ Вашите бизнес профили. Всеки профил е със следната структура:
    Параметър Тип Стойност
    id integer Идентификатор на профила.
    profile_url string URL адрес към профила в секцията Места в Grabo.bg.
    name string Наименование на профила.
    image string URL адрес към основното изображение на профила.
    num_followers integer Брой последователи (followers) на профила.
    num_ratings integer Брой оценки, поставени от потребители.
    num_reviews integer Брой ревюта (коментари), оставени от потребители.
    rating float Рейтинг (средна оценка) на профила, изчислен въз основа на всички оценки от потребители. Стойността е от 0 до 5. Ако е 0, това означава, че към момента все още няма генериран рейтинг.

    » Функция profiles/get_deals

    Връща офертите към конкретен Ваш бизнес профил, подредени по дата на стартиране, низходящо.

    Request URL:
    https://grabo.bg/api/partners/profiles/get_deals/?api_key={api_key}&company_id={company_id}&profile_id={profile_id}
    Параметри към заявката (освен задължителните api_key и company_id):
    profile_id задължителен Идентификатор на профила, чиито оферти желаете да вземете.
    filter_active незадължителен Ако се подаде true, ще върне само текущите активни оферти в Grabo.bg. В противен случай ще върне всички оферти (вкл. и изтеклите).
    num_per_page незадължителен По колко резултата да върне наведнъж. Трябва да е число между 10 и 500. Ако не се подаде, стойността ще бъде 50.
    page незадължителен Коя "страница" от резултатите да върне (на paging принцип). По подразбиране е 1.
    Примерен отговор:
    { "success": true, "error": false, "result": { "profile_id": 123456789, "filter_active": null, "items_count": 120, "num_per_page": 50, "num_pages": 3, "page": 1, "items": [ // ... ] } }
    Структура на result от отговора:
    Параметър Тип Стойност
    profile_id integer Идентификаторът на профила.
    filter_active null or integer Дали резултатите са филтрирани поради подаден параметър filter_active към заявката.
    items_count integer Брой намерени оферти, отговарящи на зададените критерии.
    num_per_page integer По колко резултата връща наведнъж, съобразно параметъра num_per_page.
    num_pages integer Брой страници с резултати.
    page integer Текуща страница, за която са върнати резултатите в items.
    items array Масив с офертите (описан по-долу), отговарящи на зададените критерии, за съответната страница page.
    Структура на всяка конкретна оферта от items:
    Параметър Тип Стойност
    id string Идентификатор на офертата.
    title string Заглавие на офертата.
    company_name string Брандът, от чието име е публикувана офертата.
    profile_id integer Идентификаторът на профила.
    image string URL адрес към основното изображение на офертата.
    date_start date Дата на стартиране на офертата (формат: YY-MM-DD hh:mm:ss).
    date_end date Дата на изтичане на офертата (формат: YY-MM-DD hh:mm:ss).
    status string Статус на офертата: ACTIVE за текущо активна оферта; ENDED за изтекла оферта; SOLDOUT за текущо активна оферта с изчерпани количества.
    variants array Вариации на продаваната услуга (описани по-долу).
    deal_url string URL адрес към офертата в потребителската част на Grabo.bg.
    partners_url string URL адрес към административната страница на офертата в Партньорския панел на Grabo.bg.
    vouchers integer Текущ брой издадени ваучери към офертата.
    vouchers_waiting integer Текущ брой непотвърдени заявки (заявени ваучери, но все още не заплатени).
    customers integer Брой потребители-купувачи с изадени ваучери по офертата.
    turnover float Оборот на офертата (сума на авансово заплатените средства от потребителите-купувачи).
    site_commission_percent float Размер (в процент от оборота) на наемната цена на Grabo.bg за конкретната оферта.
    impressions integer Текущ брой импресии на офертата (показванията ѝ в списъците с оферти в Grabo.bg).
    pageviews integer Текущ брой преглеждания на офертата на страницата ѝ в Grabo.bg.
    emails_sent integer Текущ брой писма, част от дневния e-mail бюлетин на Grabo.bg към потребители, в които офертата е участвала.
    Структура на всяка конкретна вариация на продавана услуга от variants:
    Параметър Тип Стойност
    id integer Идентификатор на варианта.
    title string Заглавие на оферираната услуга/стока.
    price_regular float Регулярна цена (цена без отстъпка) на оферираната услуга/стока.
    price_promo float Продажна цена на оферираната услуга/стока.
    amount_to_prepray float Сума, която потребителят-купувач следва да предплати към Grabo.bg, за да получи ваучер.
    amount_to_surcharge float Сума, извън предплатената, която потребителят-купувач следва допълнително да заплати към Вас.
    currency string BGN

    » Функция profiles/get_reviews

    Връща потребителските ревюта (коментари) към конкретен Ваш бизнес профил, подредени по дата, низходящо.

    Request URL:
    https://grabo.bg/api/partners/profiles/get_reviews/?api_key={api_key}&company_id={company_id}&profile_id={profile_id}
    Параметри към заявката (освен задължителните api_key и company_id):
    profile_id задължителен Идентификатор на профила, чиито ревюта желаете да вземете.
    num_per_page незадължителен По колко резултата да върне наведнъж. Трябва да е число между 10 и 500. Ако не се подаде, стойността ще бъде 50.
    page незадължителен Коя "страница" от резултатите да върне (на paging принцип). По подразбиране е 1.
    Примерен отговор:
    { "success": true, "error": false, "result": { "profile_id": 123456789, "items_count": 120, "num_per_page": 50, "num_pages": 3, "page": 1, "items": [ // ... ] } }
    Структура на result от отговора:
    Параметър Тип Стойност
    profile_id integer Идентификаторът на профила.
    items_count integer Брой намерени ревюта към този профил.
    num_per_page integer По колко резултата връща наведнъж, съобразно параметъра num_per_page.
    num_pages integer Брой страници с резултати.
    page integer Текуща страница, за която са върнати резултатите в items.
    items array Масив с ревютата (описан по-долу), за съответната страница page.
    Структура на всяко конкретно ревю от items:
    Параметър Тип Стойност
    id string Идентификатор на ревюто.
    date date Дата на ревюто (формат: YY-MM-DD hh:mm:ss).
    deal_id null or string Идентификатор на офертата, използвана от потребителя, написал ревюто. Важно: Това поле има стойност само когато съответният потребител чрез настройките си е позволил да се виждат закупените от него оферти. В противен случай стойността е null.
    user_name string Име на потребителя.
    review string Съдържание на ревюто.
    rating integer or null Оценка от 1 до 5, оставена от потребителя. Ако потребителят е написал ревю без да остави оценка, тогава стойността е null.