remp/crm-segment-module

CRM Segment Module

3.5.0 2024-10-17 10:25 UTC

Requires

• php: ^8.1

MIT

README

Segment recalculation

Default segment recalculation times:

You can configure default segment recalculation times by adding these setup method calls to your configuration file:

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')

Segment nesting

Segment nesting is a feature, that adds ability to use one segment in other segment definition.

This feature is disabled by default, since it's only supported by our default implementation of SegmentInterface. To enable it, add this to your neon configuration:

segments:
    segment_nesting: true

After enabling, new SegmentCriteria criteria is registered and available to use in visual Segments editor.

Segments editor v1

The feature is also available in segments text editor. To reference other segment in a segment query, use the code %segment.ACTUAL_SEGMENT_CODE%.

For example, let's have a segment segment_a specified by the query:

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

With feature nesting enabled, we can define segment_b query like this:

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

During segment_b execution, placeholder %segment.segment_a% will be replaced by the actual segment_a query.

API documentation

All examples use http://crm.press as a base domain. Please change the host to the one you use before executing the examples.

All examples use XXX as a default value for authorization token, please replace it with the real tokens:

• API tokens. Standard API keys for server-server communication. It identifies the calling application as a whole. They can be generated in CRM Admin (/api/api-tokens-admin/) and each API key has to be whitelisted to access specific API endpoints. By default the API key has access to no endpoint.
• User tokens. Generated for each user during the login process, token identify single user when communicating between different parts of the system. The token can be read:
  • From n_token cookie if the user was logged in via CRM.
  • From the response of /api/v1/users/login endpoint - you're free to store the response into your own cookie/local storage/session.

API responses can contain following HTTP codes:

If possible, the response includes application/json encoded payload with message explaining the error further.

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

Prints daily count of users/values in the segment with ability to filter by date range.

Endpoint requires segment_code to be provided.

Headers:

Params:

Examples:

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'

Response:

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