README

分段重新计算

默认分段重新计算时间

您可以通过将这些设置方法调用添加到配置文件中来自定义默认分段重新计算时间

segmentRecalculationConfig:
    setup:
    	# sets time of the day when segments with daily periodicity are recalculated
        - setDailyRecalculationTime('4:00')
        # sets minute of the hour in which segments with hourly periodicity are recalculated
        - setHourlyRecalculationMinute('30')

分段嵌套

分段嵌套是一种功能，它允许在另一个分段定义中使用一个分段。

由于默认实现仅支持我们的 SegmentInterface，该功能默认禁用。要启用它，请将以下内容添加到您的 neon 配置中

segments:
    segment_nesting: true

启用后，将注册新的 SegmentCriteria 标准，并在视觉分段编辑器中可用。

分段编辑器 v1

该功能也适用于分段文本编辑器。要在分段查询中引用其他分段，请使用代码 %segment.ACTUAL_SEGMENT_CODE%。

例如，假设有一个通过查询指定的分段 segment_a

SELECT users.id, users.email FROM users WHERE id > 100 AND id < 120

启用嵌套功能后，我们可以定义类似这样的 segment_b 查询

SELECT * FROM users
WHERE users.id IN (SELECT id FROM (%segment.segment_a%) a)

在 segment_b 执行期间，占位符 %segment.segment_a% 将被实际的 segment_a 查询替换。

API 文档

所有示例都使用 http://crm.press 作为基础域名。请在执行示例之前将主机更改为您使用的域名。

所有示例都使用 XXX 作为默认的授权令牌，请将其替换为实际的令牌

• API 令牌。 用于服务器间通信的标准 API 密钥。它标识整个调用应用程序。它们可以在 CRM 管理员中生成（/api/api-tokens-admin/），并且每个 API 密钥都必须白名单才能访问特定的 API 端点。默认情况下，API 密钥没有任何端点访问权限。
• 用户令牌。 在登录过程中为每个用户生成，令牌在系统不同部分之间通信时标识单个用户。令牌可以从以下位置读取
  • 从通过 CRM 登录的用户的 n_token cookie 中
  • 从 /api/v1/users/login 端点 的响应中 - 您可以将响应存储到自己的 cookie/local storage/session 中。

API 响应可以包含以下 HTTP 状态码

如果可能，响应将包含以 application/json 编码的负载，其中包含进一步解释错误的消息。

GET /api/v1/segments/daily-count-stats

打印分段的每日用户/值计数，并能够通过日期范围进行过滤。

端点需要提供 segment_code。

头部

参数

示例

curl -X GET \
  http://crm.press/api/v1/segments/daily-count-stats?segment_code=all_users \
  -H 'Authorization: Bearer XXX'

curl -X GET \
  http://crm.press/api/v1/segments/daily-count-stats?segment_code=all_users&date_from=2023-12-25 \
  -H 'Authorization: Bearer XXX'

响应

[
  {
    "date": "2024-03-24",
    "count": 299
  },
  {
    "date": "2024-03-25",
    "count": 300
  }
]