Получение статистики

Получение ссылок на размещения объявления

GET /v1/orders/{id}/urls

Обязательные параметры:

 Результат запроса 

 Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

 Тело ответа:

count - количество ссылок, доступных в данный момент
id - идентификатор сайта или фида
title - название сайта или фида
url - ссылка на размещение (либо поясняющее сообщение)

 Пример тела ответа 

{
    "data": {
        "count": 2,
        "items": [
            {
                "id": 1,
                "title": "Название сайта",
                "url": "https://example.com/link"
            },
            {
                "id": 2,
"title": "Название фида",
"url": "Объявление размещено, ссылка на объявление не предоставляется из-за особенностей сайта"
            },
        ]
    }
}

Получение ссылок на размещения объявления через фиды

GET /v1/orders/{id}/uploads/urls

Обязательные параметры:

 Результат запроса 

 Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

 Тело ответа:

count - количество ссылок, доступных в данный момент
id - идентификатор выгрузки через фид
title - название выгрузки через фид
url - ссылка на размещение (либо поясняющее сообщение)

 Пример тела ответа 

{
    "data": {
        "count": 2,
        "items": [
            {
                "id": 1,
                "title": "Название выгрузки через фид 1",
                "url": "https://example.com/link"
            },
            {
                "id": 2,
"title": "Название выгрузки через фид 2",
"url": "Объявление размещено, ссылка на объявление не предоставляется из-за особенностей сайта"
            },
        ]
    }
}

Получение общей статистики просмотров

GET /v1/orders/{id}/stats/views/boards

Обязательные параметры:

Необязательные GET-параметры:

 Результат запроса 

 Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

Тело ответа:

from - начало периода размещения объявления

to - конец периода размещения объявления

summary - общее количество просмотров

views - блок с подробными данными по просмотрам

views.id - идентификатор сайта или фида

views.title - название сайта или фида

views.url - ссылка на главную страницу сайта, где размещено объявление

views.views - количество просмотров

 Пример тела ответа 

{
    "from": "2015-02-01",
    "to": "2018-02-01",
    "summary": 1473,
    "views": {
        [
            {
                "id": 123,
                "title": "Cian",
                "url": "http://cian.ru",
                "views": 231
            },
            {
                "id": 4569,
                "title": "Название фида",
                "url": "http://avito.ru",
                "views": 1242
            },
        ]
    }
}

Если сайт не собирает статистику просмотров, тело ответа будет включать следующий контент:

            {
                "id": 4567,
                "title": "Новосёл",
                "url": "http://novosel.ru",
                "error": "Сайт не собирает статистику просмотров"
            }

Получение общей статистики просмотров телефона по объявлению

GET /v1/orders/{id}/stats/calls/boards

Обязательные параметры:

Необязательные GET-параметры:

 Результат запроса 

Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

Тело ответа:

from - начало периода размещения объявления

to - конец периода размещения объявления

summary - общее количество просмотров телефона

views - блок с подробными данными по просмотрам телефона объявления

views.id - идентификатор сайта или фида

views.title - название сайта или фида

views.url - ссылка на главную страницу сайта, где размещено объявление

views.views - количество просмотров телефона

 Пример тела ответа 

{
    "from": "2015-02-06",
    "to": "2018-02-06",
    "summary": 1473,
    "views": {
        [
            {
                "id": 123,
                "title": "Cian",
                "url": "http://cian.ru",
                "views": 231
            },
            {
                "id": 4589
                "title": "Название фида",
                "url": "http://avito.ru",
                "views": 1242
            }
        ]
    }
}

Если сайт не собирает статистику просмотров телефона, тело ответа будет содержать следующий контент:

            {
                "id"Ж 504,
                "title": "Новосёл",
                "url": "http://novosel.ru",
                "error": "Сайт не собирает статистику просмотров"
            }

Получение списка премиум-услуг объявления

GET /v1/orders/{id}/premiums

Обязательные параметры:

 Результат запроса 

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

 Пример тела ответа 

{
    "data": {
        "items": [
            {
                "board_id": 2135,
                "board_title": "Яндекс.Недвижимость",
                "type": "Премиум-объявление",
                "activated_from": {
                    "date": "2020-08-01 10:56:47.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Dubai"
                },
                "activated_to": {
                    "date": "-0001-11-30 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Dubai"
                },
                "payed_at": {
                    "date": "2020-08-01 07:05:33.000000",
                    "timezone_type": 3,
                    "timezone": "Asia/Dubai"
                }
            },
            ..
        ]
    }
}

Получение списка ошибок при размещении объявления

GET /v1/orders/{id}/errors

Обязательные параметры:

 Результат запроса 

 Заголовок:

• 200 OK - успешное выполнение
• 404 Not Found - объявление не найдено
• 403 Forbidden - объявление недоступно данному пользователю

 Тело ответа:

id - идентификатор сайта или фида
title - название сайта или фида
error - текст ошибки

 Пример тела ответа 

{
    "data": {
        "count": 2,
        "items": [
            {
                "id": 1,
                "title": "Название сайта",
                "error": "Запрещается указывать в объявлении пустое поле"
            },
            {
                "id": 2,
"title": "Название фида",
"error": "Запрещается размещать в вакансии недостоверную информацию"
            },
        ]
    }
}