Перейти к основному содержимому

Статус Страницы

В этой статье мы опишем как можно управлять Статус Страницами через API. Через API можно настроить внешний вид, домен, нотификации и многое другое.

Объект Статус Страниц

GET /v1/pages
GET /v1/pages/{page_id}

Метод для получения всех Статус Страницы организации или одной страницы по ID. Пример объекта:

{
"activity_score": 0,
"allow_email_subscribers": true,
"allow_incident_subscribers": true,
"allow_page_subscribers": true,
"allow_rss_atom_feeds": true,
"allow_sms_subscribers": true,
"allow_webhook_subscribers": true,
"city": null,
"company_logo": null,
"country": null,
"created_at": "2025-05-01T13:37:00.112486",
"css_blues": null,
"css_body_background_color": null,
"css_border_color": null,
"css_button_border_color": null,
"css_button_color": null,
"css_button_hover_color": null,
"css_button_text_color": null,
"css_font_color": null,
"css_graph_color": null,
"css_greens": null,
"css_light_font_color": null,
"css_link_color": null,
"css_no_data": null,
"css_oranges": null,
"css_reds": null,
"css_spinner_color": null,
"css_yellows": null,
"domain": null,
"email_logo": null,
"favicon_logo": null,
"headline": null,
"hero_cover": null,
"hidden_from_search": false,
"id": "4ihj1wbb3zxn",
"ip_restrictions": null,
"language": "ru",
"name": "Experimental private page",
"notifications_email_footer": null,
"notifications_from_email": null,
"organization_id": "h1pprhmsmm4l",
"page_description": "Страница для экспериментов, страница приватная",
"state": null,
"subdomain": "superdomain",
"support_url": null,
"template": "basic",
"template_id": "qu3eskzrh8zm",
"time_zone": "UTC",
"transactional_logo": null,
"updated_at": "2025-05-11T13:26:49.344877",
"url": null,
"viewers_must_be_team_members": false
}

Поля

ПолеТип объектаОписание
activity_scorenumberПоказатель активности страницы.
allow_email_subscribersbooleanРазрешено ли подписываться на обновления по электронной почте.
allow_incident_subscribersbooleanРазрешено ли подписываться на уведомления об инцидентах.
allow_page_subscribersbooleanРазрешено ли подписываться на обновления страницы.
allow_rss_atom_feedsbooleanРазрешены ли RSS и Atom-каналы.
allow_sms_subscribersbooleanРазрешено ли подписываться на SMS-уведомления.
allow_webhook_subscribersbooleanРазрешено ли подписываться на уведомления через вебхуки.
citystring or nullГород.
company_logostring or nullURL логотипа компании.
countrystring or nullСтрана.
created_atstring (ISO 8601)Дата и время создания страницы.
css_bluesstring or nullПользовательские CSS-правила для синих элементов.
css_body_background_colorstring or nullПользовательский цвет фона тела страницы.
css_border_colorstring or nullПользовательский цвет границ элементов.
css_button_border_colorstring or nullПользовательский цвет границ кнопок.
css_button_colorstring or nullПользовательский цвет фона кнопок.
css_button_hover_colorstring or nullПользовательский цвет фона кнопок при наведении.
css_button_text_colorstring or nullПользовательский цвет текста кнопок.
css_font_colorstring or nullПользовательский цвет шрифта.
css_graph_colorstring or nullПользовательский цвет графиков.
css_greensstring or nullПользовательские CSS-правила для зеленых элементов.
css_light_font_colorstring or nullПользовательский светлый цвет шрифта.
css_link_colorstring or nullПользовательский цвет ссылок.
css_no_datastring or nullПользовательский CSS для состояния "нет данных".
css_orangesstring or nullПользовательские CSS-правила для оранжевых элементов.
css_redsstring or nullПользовательские CSS-правила для красных элементов.
css_spinner_colorstring or nullПользовательский цвет спиннера загрузки.
css_yellowsstring or nullПользовательские CSS-правила для желтых элементов.
domainstring or nullПользовательский домен.
email_logostring or nullURL логотипа для электронных писем.
favicon_logostring or nullURL favicon (значка сайта).
headlinestring or nullЗаголовок страницы.
hero_coverstring or nullURL обложки (фонового изображения).
hidden_from_searchbooleanСкрыта ли страница из поисковых результатов.
idstringУникальный идентификатор страницы.
ip_restrictionsstring or nullОграничения доступа по IP-адресам.
languagestringЯзык страницы (код языка, например, "ru").
namestringНазвание страницы.
notifications_email_footerstring or nullНижний колонтитул для email-уведомлений.
notifications_from_emailstring or nullАдрес электронной почты отправителя уведомлений.
organization_idstringИдентификатор организации, которой принадлежит страница.
page_descriptionstringОписание страницы.
statestring or nullШтат, регион.
subdomainstringПоддомен страницы.
support_urlstring or nullURL службы поддержки.
templatestringИспользуемый шаблон страницы.
template_idstringИдентификатор используемого шаблона.
time_zonestringВременная зона страницы (например, "UTC").
transactional_logostring or nullURL логотипа для транзакционных писем.
updated_atstring (ISO 8601)Дата и время последнего обновления страницы.
urlstring or nullСсылка на сайт компании.
viewers_must_be_team_membersbooleanДоступ к странице разрешен только членам команды.

css_ цвета должны быть в формате HEX, например #FFFFFF.

Создать Статус Страницу

POST /v1/pages

Создать новую Статус Страницу.

Требуемые поля

ПолеТип объектаОписание
namestringНазвание страницы.

Ответ

API вернет объект Статус Страницы.

Изменить или удалить Статус Страницу

PUT /v1/pages/{page_id}
PATCH /v1/pages/{page_id}
DELETE /v1/pages/{page_id}

Удаление Статус Страницы влечет за собой удаление компонентов, инцидентов и подписчиков. Используйте те же поля, что и в объекте.