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

API трекера позволяют работать с трафиком и статистикой. Чтобы получить API-токен, зайдите на страницу своего профиля в системе. Взаимодействие с сервисом осуществляется по протоколу HTTP, статус ответа всегда 200. Стандартный формат запроса - GET или "чистый" POST (form-urlencoded). При отправке в JSON не забывайте заголовок Content-type: application/json. Формат результата - JSON. Ограничений на количество запросов нет.

Далее по тексту важные параметры указаны в фигурных скобках:

• {token} - ваш API-ключ из личного кабинета, например 123-abdce.
• {flow} - символьный идентификатор потока из списка, например ef1c.
• {click} - символьный идентификатор клика из трекера, например ca1337.

Важно! При использовании ссылок и данных фигурные скобки указывать не нужно, только сами значения!

Интеграция

Функции интеграции отвечают за подключение сторонних сервисов и передачу данных о конверсиях.

Постбек

URL: https://www.altercpa.red/api/tracker/postback.json?id={token}&click={click}

Самая главная функция взаимодействия с трекером. Создаёт новый или изменяет существующий лид по отправленным ID клика или потока. Вы можете использовать два варианта вызова:

• Стандартный вариант работы: с параметром click. Данные для лида берутся из ID клика. Используется по умолчанию, рекомендуется применять именно такой подход.
• Резервный вариант работы: с параметрами flow и subid. Данные для лида берутся из ID потока, уникальность запроса определяется по параметру subid. Подходит для случаев, где нет понятия клика и перехода по ссылке, например для интеграции приложений.

Функция может принимать на вход следующие параметры:

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа сервера:

{
    "status": "ok",
    "id": 1337,
    "create": true,
    "stage": "new"
}

Пример ответа сервера с ошибкой:

{
    "status": "error",
    "error": "no-changes"
}

Импорт расходов

URL: https://www.altercpa.red/api/tracker/spend.json?id={token}

Функция задаёт цену клика для трафика по указанным условиям. Позволяет использовать функционал расчёта ROI. Данные могут передаваться как в GET, так и в POST-запросе. В запросе обязательно должны присутствовать параметры cpc или cost и хотя бы одно условие (даты, поток, UTM-метки).

Функция может принимать на вход следующие параметры:

Вы также можете одновременно обновлять несколько ценников одним запросом, для этого объедините все запросы в массив batch и отправьте его через POST, например:

{
    "batch": [
        {
            "flow": "face",
            "cost": 1984,
            "currency": "usd"
        },
        {
            "from": "2020-04-04 00:00:00",
            "to": "2020-04-07 23:59:59",
            "cpc": 1.337,
            "currency": "eur"
        }
    ]
}

Результатом выполнения функции является ассоциативный массив:

Пример успешного ответа сервера:

{
    "status": "ok",
    "ok": 1,
    "bad": 0
}

Пример ответа сервера с ошибкой:

{
    "status": "error",
    "error": "empty"
}

Статистика

Функции статистики предоставляют доступ к отчётам по лидам и кликам.

Список лидов

URL: https://www.altercpa.red/api/tracker/leads.json?id={token}

Функция извлекает список лидов и выдаёт его в виде ассоциативного массива в поле leads. У функции нет формальных лимитов на количество выводимых лидов, но не рекомендуется выгружать больше тысячи лидов за раз. Если вы получили ошибку 500, значит на ваш запрос не хватило памяти, нужно уменьшить период запроса.

Функция может принимать на вход следующие GET-параметры фильтрации:

Результатом выполнения функции является ассоциативный массив:

Внутри поля leads лиды представлены ассоциативным массивом с полями:

Пример успешного ответа сервера:

{
    "status": "ok",
    "leads": [
        {
            "id": 1,
            "time": 1691303223,
            "click": "ac13",
            "uid": "c1vvkg272m16",
            "flow": "ecb4",
            "way": 123,
            "site": 42,
            "siteurl": "https://meow.pro/c8/cfb72fe561f0/",
            "filter": 0,
            "status": "approve",
            "custom": "Confirmed",
            "goal": "paid",
            "price": 18,
            "currency": "usd",
            "ip": "12.34.56.78",
            "geo": "de",
            "name": "Hans",
            "phone": "+49 (30) 226-511-83",
            "email": "[email protected]",
            "comment": "Confirmed on sunday",
            "meta": {
                "foo": "bar",
                "bar": "foo"
            },
            "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Safari\605.1.15",
            "referer": "https://meow.pro/c8/cfb72fe561f0/?subid=purr",
            "adid": "bf9d4aa8-4979-11ee-94c6-005056aec456",
            "data1": "wj80b89eit8epaarikhe2oge",
            "data2": false,
            "utm_source": "fb",
            "utm_campaign": "1013444211662",
            "utm_content": "432211555332166",
            "utm_term": false,
            "utm_medium": false,
            "domain": "meow.pro",
            "subid": "purr"
        },
        ...
    ]
}

Пример ответа сервера с ошибкой:

{
    "status": "error",
    "error": "payment-required"
}

Статистика по кликам

URL: https://www.altercpa.red/api/tracker/stats.json?id={token}

Функция собирает общую статистику по количеству кликов и лидов с разбивкой по целям за выбранный период по указанному критерию.

Функция может принимать на вход следующие GET-параметры фильтрации:

Результатом выполнения функции является ассоциативный массив:

Массив stats и поле total представляют собой ассоциативный массив:

Пример успешного ответа сервера:

{
    "status": "ok",
    "stats": {
        "20230805": {
            "id": 20230805,
            "name": "2023-08-05",
            "click": 44,
            "unique": 22,
            "total": 6,
            "cv": 4,
            "cn": 1,
            "ch": 1,
            "ca": 2,
            "cc": 0,
            "ct": 2,
            "mh": 20.0,
            "ma": 135.0,
            "mt": 155.0,
            "cr": 18.2,
            "epc": 6.75,
            "appr": 66.7,
            "app": 33.3
        },
        ...
    },
    "total": {
        "click": 175,
        "unique": 58,
        "total": 25,
        "cv": 23,
        "cn": 11,
        "ch": 8,
        "ca": 9,
        "cc": 0,
        "ct": 2,
        "mh": 160.0,
        "ma": 1200.0,
        "mt": 1360.0,
        "cr": 5.17,
        "epc": 12.3,
        "appr": 46.7,
        "app": 31.0
    }
}

Пример ответа сервера с ошибкой:

{
    "status": "error",
    "error": "no-item"
}