Список кодов оптимизации

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET opt_codes https://api.admitad.com/opt_codes/
  • limit**
  • offset**
  • campaign ***
  • website ***
  • order_by ****
Возвращает список кодов оптимизации.*
GET opt_codes https://api.admitad.com/opt_codes/{id}/   Возвращает код оптимизации., где id - это идентификатор кода.*
  • * Возвращает результат в формате JSON.

  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

  • *** Фильтр по рекламным программам и площадкам веб-мастера соответственно. Например campaign=3&website=12, где значения - это идентификаторы фильтруемых категорий.

  • **** Порядок сортировки. Возможные значения:

    • action_type
    • method
    • desc_mode

    Знак ‘-‘ перед значением означает обратный порядок. Например order_by=-method&order_by=desc_mode.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/opt_codes/?limit=2

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/opt_codes/3/

Пример ответа API-сервера в формате JSON:

{
    "results": [
        {
            "campaign": null,
            "desc_mode": 0,
            "event": 0,
            "generated_url": "http://127.0.0.1:8000/?oid=[[[offer_id]]]&oname=[[[offer_name]]]&ostat=[[[offer_status]]]",
            "id": 11,
            "method": 0,
            "status": [
                {
                    "id": 8
                }
            ],
            "user_url": "http://127.0.0.1:8000/",
            "website": null
        },
        {
            "campaign": null,
            "desc_mode": 0,
            "event": 0,
            "generated_url": "http://127.0.0.1:8000/?1=[[[offer_id]]]&2=[[[offer_name]]]&3=[[[offer_status]]]&4=[[[offer_status]]]&6=[[[offer_status]]]&7=[[[offer_id]]]",
            "id": 15,
            "method": 0,
            "status": [
                {
                    "id": 5
                }
            ],
            "user_url": "http://127.0.0.1:8000/",
            "website": null
        }
    ],
    "_meta": {
        "count": 3,
        "limit": 2,
        "offset": 0
    }
}

Описание полей ответа API-сервера

Название Описание
id Идентификатор кода
website Площадка кода
campaign Рекламная программа кода
event Тип события по которому срабатывает код(0 - действие, 1 - изменение статуса программы, 2 - подключение реферала)
status

Статус действия. Работает только для действий (1 - новая, 2 - принята, 3 - отклонена, 4 - ожидает)

desc_mode Режим настройки кода(0 - расширенный режим, 1 - простой режим)
action_type Тип действия(0 - Все типы, 1 - Sale, 2 - Lead)
method Метод запроса(0 - GET, 1 - POST)
user_url URL пользователя
generated_url Сгенерированный URL