Статус Страницы
В этой статье мы опишем как можно управлять Статус Страницами через 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_score | number | Показатель активности страницы. |
allow_email_subscribers | boolean | Разрешено ли подписываться на обновления по электронной почте. |
allow_incident_subscribers | boolean | Разрешено ли подписываться на уведомления об инцидентах. |
allow_page_subscribers | boolean | Разрешено ли подписываться на обновления страницы. |
allow_rss_atom_feeds | boolean | Разрешены ли RSS и Atom-каналы. |
allow_sms_subscribers | boolean | Разрешено ли подписываться на SMS-уведомления. |
allow_webhook_subscribers | boolean | Разрешено ли подписываться на уведомления через вебхуки. |
city | string or null | Город. |
company_logo | string or null | URL логотипа компании. |
country | string or null | Страна. |
created_at | string (ISO 8601) | Дата и время создания страницы. |
css_blues | string or null | Пользовательские CSS-правила для синих элементов. |
css_body_background_color | string or null | Пользовательский цвет фона тела страницы. |
css_border_color | string or null | Пользовательский цвет границ элементов. |
css_button_border_color | string or null | Пользовательский цвет границ кнопок. |
css_button_color | string or null | Пользовательский цвет фона кнопок. |
css_button_hover_color | string or null | Пользовательский цвет фона кнопок при наведении. |
css_button_text_color | string or null | Пользовательский цвет текста кнопок. |
css_font_color | string or null | Пользовательский цвет шрифта. |
css_graph_color | string or null | Пользовательский цвет графиков. |
css_greens | string or null | Пользовательские CSS-правила для зеленых элементов. |
css_light_font_color | string or null | Пользовательский светлый цвет шрифта. |
css_link_color | string or null | Пользовательский цвет ссылок. |
css_no_data | string or null | Пользовательский CSS для состояния "нет данных". |
css_oranges | string or null | Пользовательские CSS-правила для оранжевых элементов. |
css_reds | string or null | Пользовательские CSS-правила для красных элементов. |
css_spinner_color | string or null | Пользовательский цвет спиннера загрузки. |
css_yellows | string or null | Пользовательские CSS-правила для желтых элементов. |
domain | string or null | Пользовательский домен. |
email_logo | string or null | URL логотипа для электронных писем. |
favicon_logo | string or null | URL favicon (значка сайта). |
headline | string or null | Заголовок страницы. |
hero_cover | string or null | URL обложки (фонового изображения). |
hidden_from_search | boolean | Скрыта ли страница из поисковых результатов. |
id | string | Уникальный идентификатор страницы. |
ip_restrictions | string or null | Ограничения доступа по IP-адресам. |
language | string | Язык страницы (код языка, например, "ru"). |
name | string | Название страницы. |
notifications_email_footer | string or null | Нижний колонтитул для email-уведомлений. |
notifications_from_email | string or null | Адрес электронной почты отправителя уведомлений. |
organization_id | string | Идентификатор организации, которой принадлежит страница. |
page_description | string | Описание страницы. |
state | string or null | Штат, регион. |
subdomain | string | Поддомен страницы. |
support_url | string or null | URL службы поддержки. |
template | string | Используемый шаблон страницы. |
template_id | string | Идентификатор используемого шаблона. |
time_zone | string | Временная зона страницы (например, "UTC"). |
transactional_logo | string or null | URL логотипа для транзакционных писем. |
updated_at | string (ISO 8601) | Дата и время последнего обновления страницы. |
url | string or null | Ссылка на сайт компании. |
viewers_must_be_team_members | boolean | Доступ к странице разрешен только членам команды. |
css_ цвета должны быть в формате HEX, например #FFFFFF.
Создать Статус Страницу
POST /v1/pages
Создать новую Статус Страницу.
Требуемые поля
| Поле | Тип объекта | Описание |
|---|---|---|
name | string | Название страницы. |
Ответ
API вернет объект Статус Страницы.
Изменить или удалить Статус Страницу
PUT /v1/pages/{page_id}
PATCH /v1/pages/{page_id}
DELETE /v1/pages/{page_id}
Удаление Статус Страницы влечет за собой удаление компонентов, инцидентов и подписчиков. Используйте те же поля, что и в объекте.