Download the PHP package remp/crm-segment-module without Composer
On this page you can find all versions of the php package remp/crm-segment-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download remp/crm-segment-module
More information about remp/crm-segment-module
Files in remp/crm-segment-module
Package crm-segment-module
Short Description CRM Segment Module
License MIT
Homepage https://remp2030.com
Informations about the package crm-segment-module
CRM Segment Module
Segment recalculation
Default segment recalculation times:
periodicity | default recalculation time |
---|---|
minutes | asap |
hours | at 30. minute of configured hour |
days | at 4:00 hour of configured day |
You can configure default segment recalculation times by adding these setup method calls to your configuration file:
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:
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:
With feature nesting enabled, we can define segment_b
query like this:
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.
- From
API responses can contain following HTTP codes:
Value | Description |
---|---|
200 OK | Successful response, default value |
400 Bad Request | Invalid request (missing required parameters) |
403 Forbidden | The authorization failed (provided token was not valid) |
404 Not found | Referenced resource wasn't found |
500 Internal server error | Server related errors. You'll find more details in application log. |
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:
Name | Value | Required | Description |
---|---|---|---|
Authorization | Bearer String | yes | User token. |
Params:
Name | Value | Required | Description |
---|---|---|---|
segment_code | String | yes | Code of the segment. |
date_from | String | no | Optional date 'from' (inclusive). Format: YYYY-MM-DD |
date_to | String | no | Optional date 'to' (inclusive). Format: YYYY-MM-DD |
Examples:
Response: