{"openapi":"3.1.0","info":{"title":"Domclick: Статистика","description":"\n## Получение доступа\n\nДля работы с API действующий руководитель организации должен получить токен авторизации.\n\nКак получить токен:\n\n* перейдите в кабинет управления объявлениями во вкладку «Статистика»;\n* перейдите во вкладку «Статистика по API»;\n* нажмите на кнопку «Получить токен» рядом с названием нужной компании.\n\n**Важно:** сохраните полученный токен и передайте его разработчикам.  \nЕсли токен потеряется, его придётся выпускать заново.\n\n## Дата и время\nДата и время передаются с таймзоной UTC+0.\n\n## Дата начала и окончания размещения\nБесплатные объявления — информация о датах находится в схеме **OfferDataModel**.\nПоля `published_dt` — дата публикации, `publish_end_dt` — дата окончания размещения.  \nОбъявления из фида — бессрочные, поэтому дата окончания размещения не отображается.\n\nПлатные объявления — информация о датах находится в схеме **PaymentModel**.\n\n## Список значений\nЧтобы передавать список значений в параметрах запроса, передавайте элементы списка по отдельности:\n\n`?offer_ids=196032948&offer_ids=196032949`\n\nПолучение объявлений происходит постранично.\nСледующую страницу можно получить используя параметр `last_offer_id` - **ID** последнего объявления\nиз предыдущего запроса к API.\n","version":"1.0.0"},"paths":{"/v1/companies/{company_id}/offers":{"get":{"tags":["Companies"],"summary":"Информация об объявлениях компании","description":"Информация и статистика по объявлениям компании.","operationId":"get_offers_info_api_v1_companies__company_id__offers_get","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"Идентификатор компании.","title":"Company Id"},"description":"Идентификатор компании."},{"name":"token","in":"query","required":true,"schema":{"type":"string","description":"Токен компании.","title":"Token"},"description":"Токен компании."},{"name":"last_offer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Идентификатор offer_id последнего полученного объявления","default":0,"title":"Last Offer Id"},"description":"Идентификатор offer_id последнего полученного объявления"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"description":"Максимальное количество объявлений в ответе","default":1000,"title":"Limit"},"description":"Максимальное количество объявлений в ответе"},{"name":"cas_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Идентификатор в Домклике сотрудника компании","title":"Cas Id"},"description":"Идентификатор в Домклике сотрудника компании"},{"name":"feed_offer_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Список фидовых идентификаторов объявлений","title":"Feed Offer Ids"},"description":"Список фидовых идентификаторов объявлений"},{"name":"offer_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}],"description":"Список идентификаторов объявлений в Домклике","title":"Offer Ids"},"description":"Список идентификаторов объявлений в Домклике"},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SourceEnum"},{"type":"null"}],"description":"Источник объявления\\\nagent: Ручное\\\nfeed: Фид","title":"Source"},"description":"Источник объявления\\\nagent: Ручное\\\nfeed: Фид"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/StatusEnum"},{"type":"null"}],"description":"Статус объявления\\\n1: Черновик\\\n2: Опубликовано\\\n4: Опубликовано\\\n5: Ошибка\\\n7: Заблокировано модератором\\\n8: Снято с публикации\\\n20: На одобрении\\\n21: Продано\\\n23: Не размещено из-за лимитов за нарушения\\\n24: Ожидает оплаты\\\n27: Отклонено модератором. Возможно восстановить\n","title":"Status"},"description":"Статус объявления\\\n1: Черновик\\\n2: Опубликовано\\\n4: Опубликовано\\\n5: Ошибка\\\n7: Заблокировано модератором\\\n8: Снято с публикации\\\n20: На одобрении\\\n21: Продано\\\n23: Не размещено из-за лимитов за нарушения\\\n24: Ожидает оплаты\\\n27: Отклонено модератором. Возможно восстановить\n"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OfferDataModel"},"title":"Response Get Offers Info Api V1 Companies  Company Id  Offers Get"}}}},"403":{"content":{"application/json":{"example":{"errors":[{"message":"Forbidden"}],"success":false}}},"description":"Forbidden"},"422":{"content":{"application/json":{"example":{"errors":[{"ctx":{},"input":"string","loc":["string","string"],"message":"string","type":"string","url":"string"}],"success":false}}},"description":"Unprocessable Entity"}}}},"/v1/companies/{company_id}/statistic-by-days/{offer_id}":{"get":{"tags":["Companies"],"summary":"Статистика объявления компании за указанный период","description":"Возвращает статистику по одному объявлению компании за указанные дни,\n         (с ограничением в 90 дней).","operationId":"get_statistics_api_v1_companies__company_id__statistic_by_days__offer_id__get","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","description":"Идентификатор компании.","title":"Company Id"},"description":"Идентификатор компании."},{"name":"offer_id","in":"path","required":true,"schema":{"type":"integer","description":"Идентификатор объявления.","title":"Offer Id"},"description":"Идентификатор объявления."},{"name":"date_from","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Дата начала периода.","title":"Date From"},"description":"Дата начала периода."},{"name":"date_to","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Дата конца периода.","title":"Date To"},"description":"Дата конца периода."},{"name":"token","in":"query","required":true,"schema":{"type":"string","description":"Токен компании.","title":"Token"},"description":"Токен компании."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferStatisticsByDays"}}}},"403":{"content":{"application/json":{"example":{"errors":[{"message":"Forbidden"}],"success":false}}},"description":"Forbidden"},"422":{"content":{"application/json":{"example":{"errors":[{"ctx":{},"input":"string","loc":["string","string"],"message":"string","type":"string","url":"string"}],"success":false}}},"description":"Unprocessable Entity"}}}}},"components":{"schemas":{"ChatsDayStat":{"properties":{"stat_date":{"type":"string","format":"date","title":"Stat Date"},"created":{"type":"integer","title":"Created"},"answered":{"type":"integer","title":"Answered"},"unanswered":{"type":"integer","title":"Unanswered"}},"type":"object","required":["stat_date","created","answered","unanswered"],"title":"ChatsDayStat"},"ChatsStat":{"properties":{"total":{"$ref":"#/components/schemas/ChatsTotalStat"},"by_day":{"items":{"$ref":"#/components/schemas/ChatsDayStat"},"type":"array","title":"By Day"}},"type":"object","required":["total","by_day"],"title":"ChatsStat"},"ChatsTotalStat":{"properties":{"created":{"type":"integer","title":"Created"},"answered":{"type":"integer","title":"Answered"},"unanswered":{"type":"integer","title":"Unanswered"}},"type":"object","required":["created","answered","unanswered"],"title":"ChatsTotalStat"},"DiscountErrorsV2Model":{"properties":{"title":{"type":"string","title":"Title","description":"Название скидки с ошибкой"},"description":{"type":"string","title":"Description","description":"Описание скидки с ошибкой"},"rate":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Rate","description":"Размер скидки с ошибкой"},"link":{"type":"string","title":"Link","description":"Ссылка на подробную информацию о скидке с ошибкой"},"created_at":{"type":"string","title":"Created At","description":"Дата и время создания скидки с ошибкой"},"errors_compact":{"items":{"type":"string"},"type":"array","title":"Errors Compact","description":"Список ошибок в компактном формате"}},"type":"object","required":["title","description","rate","link","created_at","errors_compact"],"title":"DiscountErrorsV2Model"},"DiscountModel":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Статус скидки"},"applied_dt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Applied Dt","description":"Дата и время применения скидки"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors","description":"Список ошибок, связанных со скидкой"}},"type":"object","title":"DiscountModel"},"DiscountV2Model":{"properties":{"title":{"type":"string","title":"Title","description":"Название скидки"},"description":{"type":"string","title":"Description","description":"Описание скидки"},"status":{"type":"string","title":"Status","description":"Статус скидки"},"active_after":{"type":"string","title":"Active After","description":"Дата и время начала действия скидки"},"rate":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Rate","description":"Размер скидки"},"link":{"type":"string","title":"Link","description":"Ссылка на подробную информацию о скидке"}},"type":"object","required":["title","description","status","active_after","rate","link"],"title":"DiscountV2Model"},"ExclusiveAgentModel":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Статус эксклюзивного агента"},"confirmation_link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confirmation Link","description":"Ссылка для подтверждения эксклюзивного агента"}},"type":"object","title":"ExclusiveAgentModel"},"FavoriteDayStat":{"properties":{"stat_date":{"type":"string","format":"date","title":"Stat Date"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"count_auth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Auth"}},"type":"object","required":["stat_date","count","count_auth"],"title":"FavoriteDayStat"},"FavoritesStat":{"properties":{"total":{"items":{"$ref":"#/components/schemas/FavoriteDayStat"},"type":"array","title":"Total"},"by_day":{"anyOf":[{"items":{"$ref":"#/components/schemas/FavoriteDayStat"},"type":"array"},{"type":"null"}],"title":"By Day"}},"type":"object","required":["total"],"title":"FavoritesStat"},"ModerationInfoModel":{"properties":{"reason":{"type":"string","title":"Reason"},"comment":{"type":"string","title":"Comment"}},"type":"object","required":["reason","comment"],"title":"ModerationInfoModel"},"OfferDataModel":{"properties":{"cas_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cas Id","description":"Идентификатор пользователя"},"created_dt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Dt","description":"Дата и время создания объявления"},"deal_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Type","description":"Тип сделки","examples":["Продажа","Аренда"]},"discount":{"$ref":"#/components/schemas/DiscountModel","description":"Информация о скидке"},"discount_detail":{"anyOf":[{"$ref":"#/components/schemas/OfferDiscountV2Model"},{"type":"null"}],"description":"Детальная информация о скидках"},"domclick_link":{"type":"string","minLength":1,"format":"uri","title":"Domclick Link","description":"Ссылка на объявление на Домклик"},"exclusive_agent":{"$ref":"#/components/schemas/ExclusiveAgentModel","description":"Информация об эксклюзивном агенте"},"feed_offer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feed Offer Id","description":"Идентификатор объявления в фиде"},"is_duplicate":{"type":"boolean","title":"Is Duplicate","description":"Флаг, указывающий является ли объявление дубликатом"},"moderation":{"anyOf":[{"$ref":"#/components/schemas/ModerationInfoModel"},{"type":"null"}]},"my_domclick_link":{"type":"string","minLength":1,"format":"uri","title":"My Domclick Link","description":"Ссылка на объявление в личном кабинете Домклик"},"offer_id":{"type":"integer","title":"Offer Id","description":"Идентификатор объявления в Домклик"},"offer_type":{"anyOf":[{"$ref":"#/components/schemas/OfferType"},{"type":"null"}],"description":"Тип объекта недвижимости"},"payments":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentModel"},"type":"array"},{"type":"null"}],"title":"Payments","description":"Список платежей, связанных с объявлением"},"publish_end_dt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Publish End Dt","description":"Дата и время окончания публикации"},"published_dt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published Dt","description":"Дата и время публикации"},"source":{"anyOf":[{"$ref":"#/components/schemas/SourceType"},{"type":"null"}],"description":"Источник объявления"},"statistics":{"$ref":"#/components/schemas/StatisticModel","description":"Статистика по объявлению"},"status":{"anyOf":[{"$ref":"#/components/schemas/StatusType"},{"type":"null"}],"description":"Текущий статус объявления"},"updated_dt":{"type":"string","format":"date-time","title":"Updated Dt","description":"Дата и время последнего обновления"},"errors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Errors","description":"Список ошибок, связанных с объявлением"}},"type":"object","required":["discount","domclick_link","exclusive_agent","is_duplicate","my_domclick_link","offer_id","statistics","updated_dt"],"title":"OfferDataModel","description":"Данные об объявлении."},"OfferDiscountV2Model":{"properties":{"total_discount":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Total Discount","description":"Общий размер скидки"},"discount":{"items":{"$ref":"#/components/schemas/DiscountV2Model"},"type":"array","title":"Discount","description":"Список действующих скидок"},"discount_errors":{"items":{"$ref":"#/components/schemas/DiscountErrorsV2Model"},"type":"array","title":"Discount Errors","description":"Список скидок с ошибками"}},"type":"object","required":["total_discount","discount","discount_errors"],"title":"OfferDiscountV2Model"},"OfferStatisticsByDays":{"properties":{"offer_id":{"type":"integer","title":"Offer Id"},"views":{"$ref":"#/components/schemas/ViewsStat"},"chats":{"$ref":"#/components/schemas/ChatsStat"},"favorites":{"$ref":"#/components/schemas/FavoritesStat"}},"type":"object","required":["offer_id","views","chats","favorites"],"title":"OfferStatisticsByDays"},"OfferType":{"type":"string","enum":["Корпус жилого комплекса","Общепит","Здание","Участок (коммерция)","Жилой комплекс","Квартира (вторичка)","Свободного назначения","Гараж","Бокс","Гостиница","Дом","Часть дома","Участок","Производство","Квартира (первичка)","Офис","Парковочное место","Торговое помещение","Комната","Таунхаус","Склад"],"title":"OfferType"},"PaymentModel":{"properties":{"product":{"type":"string","title":"Product","description":"Название продукта"},"type":{"type":"string","title":"Type","description":"Тип платежа"},"start_dt":{"type":"string","format":"date-time","title":"Start Dt","description":"Дата и время начала действия платежа"},"expires_dt":{"type":"string","format":"date-time","title":"Expires Dt","description":"Дата и время окончания действия платежа"}},"type":"object","required":["product","type","start_dt","expires_dt"],"title":"PaymentModel"},"SourceEnum":{"type":"string","enum":["feed","agent"],"title":"SourceEnum"},"SourceType":{"type":"string","enum":["Ручное","Фид","Фид","Ручное","Ручное"],"title":"SourceType"},"StatisticModel":{"properties":{"views":{"type":"integer","title":"Views","description":"Количество просмотров"},"phone_shows":{"type":"integer","title":"Phone Shows","description":"Количество показов телефона"},"search_shows":{"type":"integer","title":"Search Shows","description":"Количество показов в поиске"},"chats_total":{"type":"integer","title":"Chats Total","description":"Общее количество чатов"},"chats_answered":{"type":"integer","title":"Chats Answered","description":"Количество отвеченных чатов"},"chats_unanswered":{"type":"integer","title":"Chats Unanswered","description":"Количество неотвеченных чатов"},"favorites":{"type":"integer","title":"Favorites","description":"Количество добавлений в избранное"}},"type":"object","required":["views","phone_shows","search_shows","chats_total","chats_answered","chats_unanswered","favorites"],"title":"StatisticModel"},"StatusEnum":{"type":"integer","enum":[1,2,4,5,7,8,20,21,23,24,27],"title":"StatusEnum"},"StatusType":{"type":"string","enum":["Специальный статус для перезагрузки оффера","Черновик","Опубликовано","Оффер удален из фида","Опубликовано","Ошибка","Фид деактивирован","Заблокировано модератором","Снято с публикации","Объявление снято службой модерации с возможностью исправления","Снято за неоплату","Удален пользователем в ручной подаче","На премодерации","На одобрении","Продано","Автоматически снято с публикации после окончания срока публикации","Не размещено из-за лимитов за нарушения","Ожидает оплаты","Отклонено модератором. Возможно восстановить"],"title":"StatusType"},"ViewDayStat":{"properties":{"stat_date":{"type":"string","format":"date","title":"Stat Date"},"card_views":{"type":"integer","title":"Card Views"},"phone_shows":{"type":"integer","title":"Phone Shows"},"listing_shows":{"type":"integer","title":"Listing Shows"}},"type":"object","required":["stat_date","card_views","phone_shows","listing_shows"],"title":"ViewDayStat"},"ViewTotalStat":{"properties":{"card_views":{"type":"integer","title":"Card Views"},"phone_shows":{"type":"integer","title":"Phone Shows"},"listing_shows":{"type":"integer","title":"Listing Shows"}},"type":"object","required":["card_views","phone_shows","listing_shows"],"title":"ViewTotalStat"},"ViewsStat":{"properties":{"total":{"$ref":"#/components/schemas/ViewTotalStat"},"by_day":{"items":{"$ref":"#/components/schemas/ViewDayStat"},"type":"array","title":"By Day"}},"type":"object","required":["total","by_day"],"title":"ViewsStat"}}},"servers":[{"url":"/stats"}]}