API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · campaign_segments

Campaign Segment Schema

Schema-ID
campaign_segment
Collection
campaign_segments
Permissions
  • Lesencampaign_segment_view
  • Anlegencampaign_segment_manage
  • Änderncampaign_segment_manage
  • Löschencampaign_segment_manage

Felder

Campaign Segment Schema

campaign_segments4 Permissions

Reusable dynamic audience definition for campaigns. The query tree is translated to a MongoDB aggregation pipeline at evaluation time. See ADR 0040 / segment-evaluator.ts.

namestringerforderlich
1–200 Zeichen
descriptionstringoptional
max 2000 Zeichennullable
baseEntitystringerforderlich

Schema id of the base entity (e.g. "party", "asset", "contact").

1–64 Zeichen
queryobjecterforderlich

SegmentQuery tree. Either { op: "AND"|"OR"|"NOT", children: [...] } or a Condition node.

modestringoptional

Default evaluation mode hint when this segment is used by a campaign (overridable on the campaign).

Werte
STATICDYNAMIC
Default: "STATIC"
tagsstring[]optional
Default: []
lastEvaluatedAtdatetimeoptional
read-onlynullable
lastEvaluatedCountintegeroptional
≥ 0read-onlynullable
isSystembooleanoptional

System-provided segment templates cannot be deleted.

Default: falseread-only

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/campaign_segments — Liste, paginiert + filterbar
  • GET /api/v1/campaign_segments/<id> — Einzelne Entity
  • POST /api/v1/campaign_segments — Anlegen
  • PATCH /api/v1/campaign_segments/<id> — Teil-Update
  • DELETE /api/v1/campaign_segments/<id> — Soft-Delete
  • GET /api/v1/campaign_segments/<id>/timeline — Audit + Aktivitäten

Suche