API партнерской статистики

Партнерам доступно получение партнерской статистики без входа в личный кабинет. С помощью API партнер может запросить:

  • баланс;
  • информацию по выплатам партнерского вознаграждения;
  • данные по переходам и покупкам.

В данной статье приводятся примеры работы с API в. виде html запросов. Примеры и описания запросов на PHP, Ruby, Python и cURL находятся на странице «Travelpayouts API».

 

Доступ к данным

Для получения данных вместе с запросом требуется передавать партнерский токен. Он доступен всем партнерам сразу после регистрации в личном кабинете.

 

Баланс

Возвращает текущее состояние баланса партнера.

Запрос

http://api.travelpayouts.com/v2/statistics/balance?token=APItoken

Параметры запроса

  • token — ваш партнерский токен.

Ответ

{
    "success":true,
    "data":{
        "balance":1416.07,
        "currency":"RUB"
    }
}

Параметры ответа

  • success — запрос завершился успешно (true) или возникла ошибка (false);
  • balance — сумма средств на балансе партнерского счета;
  • currency — валюта счета.

 

Выплаты партнерского вознаграждения

Возвращает список выплат партнеру с момента регистрации в партнерской программе.

Запрос

http://api.travelpayouts.com/v2/statistics/payments?token=APItoken

Параметры запроса

  • token — ваш партнерский токен.

Ответ

{
    "success":true,
    "data":{
        "payments":[
            {
                "timestamp":"2015-05-11 05:47:18",
                "status":"paid",
                "currency":"rub",
                "amount":3399.07,
                "comment":"Travelpayouts"
            }
        ]
    }
}

Параметры ответа

  • success — запрос завершился успешно (true) или возникла ошибка (false);
  • timestamp — дата совершения платежа;
  • status — статус операции (paid — выплата вознаграждения);
  • currency — валюта платежа;
  • amount — сумма операции;
  • comment — комментарий для платежа.

 

Данные по переходам и покупкам

Данные по дате, доп. маркеру или хосту

Возвращает количество поисков/кликов/бронирований и заработок по ним, сгруппированные по дате, доп. маркеру или хосту. Данные за месяц, как по отелям, так и по авиабилетам.

Запрос

http://api.travelpayouts.com/v2/statistics/sales?group_by=date&month=2015-05-14&host_filter=null&marker_filter=null&token=APItoken

Параметры запроса

  • group_by — способ группировки:
    • date — по дате;
    • host — по хосту;
    • marker — по дополнительному маркеру.
  • month — месяц, за который формируется отчет;
  • host_filter — фильтровать по указанному хосту. Если в работе используется White Label, то с помощью этого фильтра можно получить данные по его результативности;
  • marker_filter — фильтровать по дополнительному маркеру;
  • token — ваш партнерский токен.

Ответ

{
    "success":true,
    "data":{
        "sales":[
        {
            "key":"2015-05-14",
            "flights":{
                "visitors":1,
                "searches":17,
                "clicks":0,
                "paid_clicks":0,
                "paid_clicks_profit":0,
                "bookings":0,
                "paid_bookings":0,
                "paid_bookings_profit":0,
                "pending_bookings_profit":0
             },
             "hotels":{
                "visitors":0,
                "searches":0,
                "clicks":0,
                "paid_clicks":0,
                "paid_clicks_profit":0,
                "bookings":0,
                "paid_bookings":0,
                "paid_bookings_profit":0,
                "pending_bookings_profit":0
             }
        }
    ]
    }
}

Параметры ответа

  • success — запрос завершился успешно (true) или возникла ошибка (false);
  • key — отчетная дата;
  • flights — массив данных по авиабилетам / hotels — массив данных по отелям:
    • visitors — количество человек, перешедших по партнерской ссылке и совершивших хотя бы один поиск;
    • searches — количество посетителей, воспользовавшихся формой поиска (ввели запрос и нажали «Найти»);
    • clicks — количество посетителей, кликнувших на ссылку в результатах поиска
    • paid_clicks — количество платных кликов (к системе подключено несколько агентств, которые платят не комиссию за бронирование, а за клик в поиске на ссылки на агентства);
    • paid_clicks_profit — доход от платных кликов;
    • bookings — количество посетителей, забронировавших билеты/номера в отелях;
    • paid_bookings — количество оплаченных броней;
    • paid_bookings_profit — полученный партнером доход от оплаченных броней;
    • pending_bookings_profit — отображается суммарных доход с бронирований, находящихся в статусе «В процессе».

 

Данные по дате и доп. маркеру

Возвращает количество поисков/кликов/бронирований и заработок по ним, сгруппированные по дате и доп. маркеру. Данные за месяц, как по отелям, так и по авиабилетам.

Запрос

http://api.travelpayouts.com/v2/statistics/detailed-sales?group_by=date_marker&month=2015-05-14&host_filter=null&marker_filter=null&token=APItoken

Параметры запроса

  • group_by — способ группировки:
    • date_marker — по дате и маркеру.
  • month — месяц, за который формируется отчет;
  • host_filter — фильтровать по указанному хосту. Если в работе используется White Label, то с помощью этого фильтра можно получить данные по его результативности;
  • marker_filter — фильтровать по дополнительному маркеру;
  • token — ваш партнерский токен.

Ответ

{
    "success":true,
    "data":{
        "sales":{
            "2015-05-01":{
                "16886":{
                    "flights":{
                        "visitors":2,
                        "searches":394,
                        "clicks":0,
                        "paid_clicks":0,
                        "paid_clicks_profit":0,
                        "bookings":0,
                        "paid_bookings":0,
                        "paid_bookings_profit":0,
                        "pending_bookings_profit":0
                    },
                    "hotels":{
                        "visitors":9,
                        "searches":9,
                        "clicks":0,
                        "paid_clicks":0,
                        "paid_clicks_profit":0,
                        "bookings":0,
                        "paid_bookings":0,
                        "paid_bookings_profit":0,
                        "pending_bookings_profit":0
                        }
                    },
                    "test":{
                        "flights":{
                            "visitors":1,
                            "searches":1,
                            "clicks":0,
                            "paid_clicks":0,
                            "paid_clicks_profit":0,
                            "bookings":0,
                            "paid_bookings":0,
                            "paid_bookings_profit":0,
                            "pending_bookings_profit":0
			    },
			"hotels":{
                            "visitors":0,
                            "searches":0,
                            "clicks":0,
                            "paid_clicks":0,
                            "paid_clicks_profit":0,
                            "bookings":0,
                            "paid_bookings":0,
                            "paid_bookings_profit":0,
                            "pending_bookings_profit":0
                        }
                    }
                }
            }
        }
}

Параметры ответа

  • success — запрос завершился успешно (true) или возникла ошибка (false);
  • sales — массив данных в разрезе дат (напр. 2015-05-01);
  • 16886 / test — внутри каждой даты находится перечень партнерских маркеров, по которым были переходы/поиски/бронирования:
    • flights — массив данных по авиабилетам / hotels — массив данных по отелям:
      • visitors — количество человек, перешедших по партнерской ссылке и совершивших хотя бы один поиск;
      • searches — количество посетителей, воспользовавшихся формой поиска (ввели запрос и нажали «Найти»);
      • clicks — количество посетителей, кликнувших на ссылку в результатах поиска
      • paid_clicks — количество платных кликов (к системе подключено несколько агентств, которые платят не комиссию за бронирование, а за клик в поиске на ссылки на агентства);
      • paid_clicks_profit — доход от платных кликов;
      • bookings — количество посетителей, забронировавших билеты/номера в отелях;
      • paid_bookings — количество оплаченных броней;
      • paid_bookings_profit — полученный партнером доход от оплаченных броней;
      • pending_bookings_profit — отображается суммарных доход с бронирований, находящихся в статусе «В процессе».

Была ли эта статья полезной?

Еще есть вопросы? Отправить запрос