Документация API JCat.Недвижимость

Отчет в формате xml

Данный отчёт подходит для пакетом с количеством активных объявлений менее 500, если объявлений больше, то длительность формирования может быть более минуты.

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

По данному адресу можно получить отчет о размещении в xml-формате: https://jcat.ru/api/report/xml-report.php

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

Ссылка с ключом имеет вид: https://jcat.ru/api/report/xml-report.php?apiKey=SG5423ds2G

Вы можете получить отчет по объявлениям вне пакетов и объявлениям конкретного пакета.

Отчет по объявлениям без пакета можно запросить по ссылке вида: https://jcat.ru/api/report/xml-report.php?outOfPackets=1&apiKey=SG5423ds2G

Отчет по конкретному пакету можно запросить по ссылке вида: https://www.jcat.ru/api/report/xml-report.php?packetId=30541&apiKey=SG5423ds2G

Для скачивания отчета необходимо добавить параметр &download=1

Структура отчёта:

<report>
    <generateDateTime>Дата генерации отчёта</generateDateTime>
    <packetId>Идентификатор пакета, в котором размещается объявление</packetId>
    <objects> Список объявлений
        <object jcatId="Идентификатор объявления в сервисе Jcat.ru" 
                clientId="Идентификатор объявления в системе клиента (атрибут отсутствует, если объявление не имеет этого параметра)">
            <address>Адрес из объявления</address>
            <boards> Список сайтов-партнёров, на которых объявление должно размещаться
                <board name="Название сайта-партнёра, по которому передаётся статистика">
                    <link>
                    Ссылка на объявление / причина, по которой объявление не было выгружено на сайт
                    </link>
                    <visits>Количество просмотров объявления за весь период выгрузки на сайт-партнёр</visits>
                        <phoneViews>
                            Количество открытий номеров телефона объявления за весь период выгрузки на сайт-партнёр / При невозможности
                            получении этой информации выводится текст "сайт не собирает статистику просмотров телефона"
                        </phoneViews>
                        <visitsDaily> Подневная статистика просмотров объявления
                        <visit>
                        <date>Дата в формате Y-m-d</date>
                        <value>Количество просмотров</value>
                        </visit>
                        <visit>
                        <date>Дата в формате Y-m-d</date>
                        <value>Количество просмотров</value>
                        </visit>..
                    </visitsDaily>
                    <phoneViewsDaily> Подневная статистика открытий номеров телефонов
                        <visit>
                            <date>Дата в формате Y-m-d</date>
                            <value>Количество открытий</value>
                        </visit>..
                    </phoneViewsDaily>
                    <status>
                        Статус объявления на сайте-партнёре:
                        published - публикуется
                        inactive - не активно
                        moderation - модерация объявления
                        rejected - отклонено
                        import_error - ошибка импорта  данных сайтом-партнёром
                        export_error - ошибка выгрузки объявления на сайт-партнёр
                    </status>
                    <errors> Список ошибок по объявлению
                        <error>
                            <code>Идентификатор ошибки</code>
                            <text>
                            Текст ошибки
                            </text>
                        </error>
                    </errors>
                </board> ..
            </boards>
        </object>
    </objects>
</report>