Rick.ai data API

API предназначено для выгрузки первичных данных из Rick.ai

Документация

Спецификация API в формате OpenAPI (Swagger 2.0)

Интерфейс тестирования API

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

Работа с API осуществляется в зашифрованном виде по протоколу HTTPS, формат ответа JSON.

Авторизация осуществляется посредством передачи токена в заголовке HTTP запроса Rick-Auth-Token.

Предусмотрены механизмы ограничения активности работы с API:

• не более 1 параллельно выполняющегося запроса,
• не более 1 запроса в секунду.

curl --request GET \
  --url 'https://api.rick.ai/v2/example-company/sessions?start=2018-09-08&end=2018-10-08' \
  --header 'Rick-Auth-Token: eyjhbglhcyi6imv4yw1wbcisimf1dghfyxbwx2lkijoxmjm0fq'

Версия : 2.0.2

Узел : api.rick.ai
Схемы : HTTPS

GET /v2/{company}/sessions

Возвращает данные сессий посетителей в заданном диапазоне дат

• application/json

/v2/example-company/sessions

json :
{
  "start" : "2018-10-01",
  "end" : "2018-10-31",
  "limit" : 10000,
  "offset" : 20000,
  "page" : 1
}

json :
{
  "items" : [ {
    "client_id" : "123456789.123456789",
    "session_count" : 29,
    "date" : "2018-10-03",
    "source_medium" : "google / cpc",
    "real_source_medium" : "google / cpc",
    "campaign" : "retargeting-display",
    "campaign_type" : "search brand",
    "keyword" : "+скачать +без +регистрации +и +смс",
    "channel_group" : "Google Adwords",
    "channel_type" : "paid",
    "country" : "Russia",
    "region" : "Voronezh Oblast",
    "city" : "Voronezh",
    "browser" : "Chrome",
    "browser_version" : "69.0.3497.100",
    "operating_system" : "Android",
    "device_category" : "tablet",
    "screen_resolution" : "601x962",
    "app_version" : "1.0.12",
    "mobile_device_info" : "Samsung SM-T285 Galaxy Tab A 7.0 LTE",
    "landing_page_path" : "/featured/",
    "initial_landing_page_path" : "/pricing/",
    "hostname" : "rick.ai",
    "ad_content" : "Ретаргетинг 10% скидка",
    "channel_grouping" : "Ретаргетинг кампании",
    "acq_cost" : 16.87,
    "revenue" : 600.0,
    "transactions" : [ {
      "transaction_id" : "HGJES-673",
      "status" : "Оплачено",
      "deal_source" : "jivosite",
      "revenue" : 600.0,
      "grossprofit" : 400.0,
      "products" : [ {
        "sku" : "SUB-MONTH",
        "name" : "Подписка (1 месяц)",
        "category" : "Подписка",
        "price" : 600.0,
        "quantity" : 1
      } ],
      "status_history" : [ {
        "status" : "Оплачено",
        "date" : "2018-10-03"
      } ]
    } ],
    "page_paths" : [ "/pricing" ],
    "actions" : [ "sign-in" ],
    "screen_names" : [ "main" ],
    "user_ids" : [ "63826" ]
  } ],
  "total" : 1298
}

json :
{
  "error" : "limit cannot be lower than 0"
}

json :
{
  "error" : "unauthenticated for invalid credentials"
}

json :
{
  "error" : "request with this token already running"
}

json :
{
  "error" : "gateway timeout"
}

Тип : apiKey
Имя : Rick-Auth-Token
Содержится в : HEADER