Introduction

Rule model

Standard rule JSON model returned from many API endpoints.

Example

{
  "id": 5,
  "event_type": "app_opened",
  "name": {
    "value": "Use coupon \"Valentines\"",
    "translations": {
      "pl": "Użycie kuponu \"Walentynki\""
    }
  },
  "frequency": {
    "rate": 0,
    "limit": 1,
    "minimum": 0,
    "timespan": "day"
  },
  "limit": 5000,
  "minimum": 0,
  "rate": null,
  "hook_type": "rewards_api",
  "hook_delayed_by_seconds": 5,
  "options": {
    "rewards_api": {
      "grant_points": 3
    }
  },
  "data_conditions": null,
  "audience_id": 42,
  "excluded_sources": ["webforms", "some-external-product"],
  "paused": false,
  "created_at": "2019-02-26T13:22:43.495Z",
  "updated_at": "2019-02-28T15:29:24.156Z",
  "deleted_at": null
}

Definition

Key	Description	Type
id	Rule ID	integer
event_type	Event type	string
name	Object with rule name including it's translations	JSON Object
frequency	Object describing rule trigger frequency	JSON Object
limit	Maximum actions per member	integer
minimum	Minimum number of such events before actual action per member	integer
rate	Execute action each X event per member	integer
hook_type	hook type	string
hook_delayed_by_seconds	Delay in seconds after which hook will be triggered	integer
data_conditions	Data conditions object see rule schema	JSON Object
audience_id	Audience identifier	integer
excluded_sources	List of API sources/products that should not trigger the action	Array
paused	Indicates if rule execution is paused	Bool
created_at	Tine of rule creation	Date
updated_at	Time of last rule update	Date
deleted_at	Time of rule deletion	Date

Rule model#

Example#

Definition#

Rule model

Example

Definition