Дашборды

Методов в разделе: 2. Все методы

Метод	Путь	Описание	Области	Статус
GET	`/dashboards/overview`	Дашборд «Обзор»	`dashboards:read`	Доступно
GET	`/dashboards/pulse`	Дашборд «Пульс»	`dashboards:read`	Доступно

GET /dashboards/overview Доступно

#Дашборд «Обзор»

Срез экрана «Обзор»: до одиннадцати блоков, каждый со своей доступностью (ok, no_data, no_source, not_connected) и датой данных. Сбой одного источника не превращается в пустой блок: ответ 503.

Области: dashboards:read
Предел частоты: чтение
Идемпотентность: не требуется
Успешный ответ: 200 Запрошенные блоки в порядке экрана.

Параметры

Поле	Тип	Описание
`from`	string необязательное	Где: query. Начало периода, включительно. Формат YYYY-MM-DD.
`to`	string необязательное	Где: query. Конец периода, включительно; не позже последних полных суток (позднее значение обрезается и возвращается в ответе). Формат YYYY-MM-DD.
`blocks`	string необязательное	Где: query. Блоки через запятую; по умолчанию все: strategist, kpi, funnel, attention, ads, ai_assistants, popular_pages, clusters, data_trust, sitemap_health, status.

Тело ответа

Поле	Тип	Описание
`data`	object обязательное
`data.from`	string обязательное	Дата YYYY-MM-DD.
`data.to`	string обязательное	Дата YYYY-MM-DD.
`data.blocks`	object обязательное
`data.blocks.strategist`	object необязательное
`data.blocks.strategist.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.strategist.reason`	string необязательное
`data.blocks.strategist.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.kpi`	object необязательное
`data.blocks.kpi.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.kpi.reason`	string необязательное
`data.blocks.kpi.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.funnel`	object необязательное
`data.blocks.funnel.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.funnel.reason`	string необязательное
`data.blocks.funnel.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.attention`	object необязательное
`data.blocks.attention.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.attention.reason`	string необязательное
`data.blocks.attention.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.ads`	object необязательное
`data.blocks.ads.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.ads.reason`	string необязательное
`data.blocks.ads.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.ai_assistants`	object необязательное
`data.blocks.ai_assistants.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.ai_assistants.reason`	string необязательное
`data.blocks.ai_assistants.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.popular_pages`	object необязательное
`data.blocks.popular_pages.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.popular_pages.reason`	string необязательное
`data.blocks.popular_pages.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.clusters`	object необязательное
`data.blocks.clusters.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.clusters.reason`	string необязательное
`data.blocks.clusters.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.data_trust`	object необязательное
`data.blocks.data_trust.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.data_trust.reason`	string необязательное
`data.blocks.data_trust.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.sitemap_health`	object необязательное
`data.blocks.sitemap_health.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.sitemap_health.reason`	string необязательное
`data.blocks.sitemap_health.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.
`data.blocks.status`	object необязательное
`data.blocks.status.availability`	string обязательное	Значения: `ok` `no_data` `no_source` `not_connected`
`data.blocks.status.reason`	string необязательное
`data.blocks.status.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.

Примеры

Запрос

curl -X GET 'https://formula-cream.pro/api/public/v1/dashboards/overview' \
  -H 'Authorization: Bearer '"$SAPPORT_API_KEY"

Ответ 200

{
  "data": {
    "from": "string",
    "to": "string",
    "blocks": {
      "strategist": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "kpi": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "funnel": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "attention": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "ads": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "ai_assistants": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "popular_pages": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "clusters": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "data_trust": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "sitemap_health": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      },
      "status": {
        "availability": "ok",
        "reason": "string",
        "data_as_of": {}
      }
    }
  }
}

Пример ошибки

{
  "type": "https://formula-cream.pro/developers/errors#scope_missing",
  "title": "Scope is missing",
  "status": 403,
  "code": "scope_missing",
  "detail": "EXAMPLE",
  "request_id": "req_EXAMPLE"
}

Примеры иллюстративны: ключ в них условный (EXAMPLE), значения полей выдуманы.

Возможные ошибки

invalid_api_key wrong_cell integration_inactive tenant_inactive ip_not_allowed feature_not_in_plan rate_limited wallet_suspended service_unavailable internal_error scope_missing validation_failed

GET /dashboards/pulse Доступно

#Дашборд «Пульс»

Находки «Пульса»: темы спроса, которые начали расти, с источниками сигнала и связанной темой очереди стратега.

Области: dashboards:read
Предел частоты: чтение
Идемпотентность: не требуется
Успешный ответ: 200 Находки периода.

Параметры

Поле	Тип	Описание
`from`	string необязательное	Где: query. Начало периода, включительно. Формат YYYY-MM-DD.
`to`	string необязательное	Где: query. Конец периода, включительно; не позже последних полных суток (позднее значение обрезается и возвращается в ответе). Формат YYYY-MM-DD.

Тело ответа

Поле	Тип	Описание
`data`	object обязательное
`data.period`	object обязательное
`data.period.from`	string обязательное	Дата YYYY-MM-DD.
`data.period.to`	string обязательное	Дата YYYY-MM-DD.
`data.new_7d`	integer обязательное
`data.truncated`	boolean обязательное
`data.alerts`	array<PulseAlert> обязательное
`data.data_as_of`	object обязательное	Источник → дата, по которую его данные полны. Источник без данных в объект не попадает.

Примеры

Запрос

curl -X GET 'https://formula-cream.pro/api/public/v1/dashboards/pulse' \
  -H 'Authorization: Bearer '"$SAPPORT_API_KEY"

Ответ 200

{
  "data": {
    "period": {
      "from": "string",
      "to": "string"
    },
    "new_7d": 0,
    "truncated": false,
    "alerts": [
      {
        "id": null,
        "topic_id": null,
        "topic_name": null,
        "keyword": null,
        "horizon": null,
        "status": null,
        "episode_start": null,
        "last_seen": null,
        "score": null,
        "volume": null,
        "growth": null,
        "sources": null,
        "strategist_topic": null
      }
    ],
    "data_as_of": {}
  }
}

Пример ошибки

{
  "type": "https://formula-cream.pro/developers/errors#scope_missing",
  "title": "Scope is missing",
  "status": 403,
  "code": "scope_missing",
  "detail": "EXAMPLE",
  "request_id": "req_EXAMPLE"
}

Примеры иллюстративны: ключ в них условный (EXAMPLE), значения полей выдуманы.

Начало

Чаты и ИИ-продажник

Аналитика и дашборды

CRM и лиды

Статьи

Стратег

Дополнительно

Справочник API

Дашборды

#Дашборд «Обзор»

Параметры

Тело ответа

Примеры

Возможные ошибки

#Дашборд «Пульс»

Параметры

Тело ответа

Примеры

Возможные ошибки