Segment Rules

Endpointhttps://api.kontorion.eu/v1

List segment rules

GET

https://api.kontorion.eu/v1

/segment-rules

Returns all active segment rules for the organization

List segment rules › Responses

Wrapped in data envelope

object[]

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

Create a segment rule

POST

https://api.kontorion.eu/v1

/segment-rules

Creates a new segment rule for the organization

Create a segment rule › Request Body

applied_tag_id

string

evaluation_schedule

string

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

value

number

Create a segment rule › Responses

Wrapped in data envelope

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

POST/segment-rules

curl --request POST \
  --url https://api.kontorion.eu/v1/segment-rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "applied_tag_id": "applied_tag_id",
  "evaluation_schedule": "evaluation_schedule",
  "metric": "monthly_spend",
  "operator": "gte",
  "value": 0
}
'

shell

Example Request Body

{
  "applied_tag_id": "applied_tag_id",
  "evaluation_schedule": "evaluation_schedule",
  "metric": "monthly_spend",
  "operator": "gte",
  "value": 0
}

json

Example Responses

{
  "key": {
    "applied_tag_id": "applied_tag_id",
    "created_at": "created_at",
    "deleted_at": "deleted_at",
    "evaluation_schedule": "evaluation_schedule",
    "id": "id",
    "is_active": true,
    "metric": "monthly_spend",
    "operator": "gte",
    "organization_id": "organization_id",
    "updated_at": "updated_at",
    "value": 0
  }
}

json

application/json

Get a segment rule

GET

https://api.kontorion.eu/v1

/segment-rules/{id}

Returns a single segment rule by ID

Get a segment rule › path Parameters

id

string · required

Segment rule UUID

Get a segment rule › Responses

Wrapped in data envelope

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

Delete a segment rule

DELETE

https://api.kontorion.eu/v1

/segment-rules/{id}

Soft-deletes a segment rule by ID

Delete a segment rule › path Parameters

id

string · required

Segment rule UUID

Delete a segment rule › Responses

No content

No data returned

Search Settlements

List segment rules

GET

https://api.kontorion.eu/v1

/segment-rules

Returns all active segment rules for the organization

List segment rules › Responses

Wrapped in data envelope

object[]

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

Create a segment rule

POST

https://api.kontorion.eu/v1

/segment-rules

Creates a new segment rule for the organization

Create a segment rule › Request Body

applied_tag_id

string

evaluation_schedule

string

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

value

number

Create a segment rule › Responses

Wrapped in data envelope

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number

Get a segment rule

GET

https://api.kontorion.eu/v1

/segment-rules/{id}

Returns a single segment rule by ID

Get a segment rule › path Parameters

id

string · required

Segment rule UUID

Get a segment rule › Responses

Wrapped in data envelope

applied_tag_id

string

created_at

string

deleted_at

string

evaluation_schedule

string

id

string

is_active

boolean

metric

string · enum

Enum values:

monthly_spend

total_spend

subscription_count

active_days

operator

string · enum

Enum values:

gte

lte

organization_id

string

updated_at

string

value

number