Data Structures

Section: Data Structures. Base URL: https://instance_name.meiro.io/api/.

Notifications

Notification (enum)

(Attribute Created Notification)
(Attribute Updated Notification)
(Attribute Hidden Notification)
(Attribute Showed Notification)

Notification Base

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a
read: true (boolean)
importance: high, medium, low (enum)
timestamp: 2021-03-14T16:50:50.514Z - ISO8601 date string in UTC

Attribute Notifications

Attribute

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a
name: nps_score
description: example description

Segment Partial

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a
name: segment name

Insight Partial

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a
name: insight name

Attribute Created Notification (Notification Base)

category: ATTRIBUTE (fixed)
details
- type: AttributeCreated (fixed)
- attribute (Attribute)

Attribute Updated Notification (Notification Base)

category: ATTRIBUTE (fixed)
details
- type: AttributeUpdated (fixed)
- old_attribute (Attribute) - The attribute object before the update
- new_attribute (Attribute) - The attribute object after the update
- updated_properties: name, description, tags
- used_in
  - segments (array[Segment Partial])
  - insights (array[Insight Partial])

Attribute Hidden Notification (Notification Base)

category: ATTRIBUTE (fixed)
details
- type: AttributeHidden (fixed)
- attribute (Attribute)

Attribute Showed Notification (Notification Base)

category: ATTRIBUTE (fixed)
details
- type: AttributeShowed (fixed)
- attribute (Attribute)

Customer events upload

CustomerEventUpload

source_id: source id (string)
type: type (string)
version: 1-0-0 (string)
user_identifier: uniquely identifies a user (string)
event_time: 2022-09-01T12-01-02Z (string)
payload (object)

AsyncUploadStatus (enum)

NEW
UPLOADING
DONE
ERROR

AsyncUpload

id: 123e4567-e89b-12d3-a456-426614174000 (string)
created: 2022-09-01T12-01-02Z (string)
updated: 2022-09-01T12-01-02Z (string)
status: NEW (AsyncUploadStatus)
errors (array[string])
count: 0 (number)

Channels

FrequencyCapPeriodType

days
hours

FrequencyCapPeriod

type 'days' (FrequencyCapPeriodType)
size (number)

ChannelFrequencyCap

max_count (number)
period (FrequencyCapPeriod)

DeliveryTime

is_active (boolean)
days (array[enum[string]])
- Members
  - monday
  - tuesday
  - wednesday
  - thursday
  - friday
  - saturday
  - sunday
start: 12:00 (string)
end: 13:00 (string)
time_zone: Europe/Prague (string)

WhatsappGlobalSettings

frequency_cap (ChannelFrequencyCap)
delivery_time (DeliveryTime, nullable)

ChannelEntityFrequencyCap

ignore_channel_frequency_cap (boolean)
max_count (number)
period (FrequencyCapPeriod)

SegmentExportDestinationSchedule

destination_id (number)
schedule_type (string)
schedules (array[Schedule])

Position (enum)

top_left
top_right
middle
bottom_left
bottom_right

WebBannersSelectionSettings

limit: 10 (number, optional) - Limit of the number of records returned
offset: 20 (number, optional) - Offset for the records returned

HideSubject (enum)

HideOperator (enum)

equals_any
not_equal_any
contains_any
not_contain_any

HideCondition

subject: url (HideSubject)
operator: equals (HideOperator)
values (array[string])

WebBannerHtmlContent

html: <content/> (string)

WebBannerImageContent

destination_url (string)
html: <img src> (string)
type: LOCAL (string) one of LOCAL, REMOTE
image_name: picture.png (string)

WebBannerMinimizedImageContent

html: <img src> (string)
type: LOCAL (string) one of LOCAL, REMOTE
image_name: picture.png (string)
hide_condition (HideCondition, optional)

WebBannerModifyContent

destination_url (string)
html (string)
image_url (string)
data: base64 image content (string)
image_name: picture.png (string)

WebBannerModifyMinimizedContent

enabled (boolean)
html (string)
image_url (string)
data: base64 image content (string)
image_name: picture.png (string)
hide_condition (HideCondition, optional)

FrequencyCapPerUserWindow

max_display_count: 10 (number)
size: 1 (number, optional)
type: hours (string) - one of hours, days, session

FrequencyCapPerUser

window (FrequencyCapPerUserWindow)
max_display_count: 10 (number, optional)

FrequencyCap

per_user (FrequencyCapPerUser)
max_display_count: 10 (number, optional)

PopUpWebBannerSettings

condition (object)
frequency_cap (FrequencyCap)
priority: 0 (number)
position: top_left (Position)
content (object) - one of WebBannerHtmlContent or WebBannerImageContent
minimized_content (object) - one of WebBannerHtmlContent or WebBannerMinimizedImageContent
content_type: html (string) - one of html, image
fe_settings (object)
tracking_disabled (boolean)
global_frequency_cap_ignored (boolean)

EmbeddedWebBannerSettings

condition (object)
frequency_cap (FrequencyCap)
priority: 0 (number)
content (object) - one of WebBannerHtmlContent or WebBannerImageContent
fe_settings (object)
tracking_disabled (boolean)

PopUpWebBannerSettingsUpdate

condition (object, optional)
frequency_cap (FrequencyCap, optional)
priority: 0 (number, optional)
position: top_left (Position, optional)
content (WebBannerModifyContent, optional)
minimized_content (WebBannerModifyMinimizedContent, optional)
content_type: html (string, optional) - one of html, image
fe_settings (object, optional)
tracking_disabled (boolean, optional)
global_frequency_cap_ignored (boolean, optional)

EmbeddedWebBannerSettingsUpdate

condition (object, optional)
frequency_cap (FrequencyCap, optional)
priority: 0 (number, optional)
content (WebBannerModifyContent, optional)
fe_settings (object, optional)
tracking_disabled (boolean, optional)

PopUpWebBanner

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - Banner's unique UUID
user_id: 1 (number) - Banner's last modifier ID
name: My banner (string) - Banner's name
settings (PopUpWebBannerSettings) - Banner's settings
disabled: false (boolean) - Banner's activity flag
created: 2021-05-05 12:00:00 - Banner's last update datetime

EmbeddedWebBanner

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - Banner's unique UUID
user_id: 1 (number) - Banner's last modifier ID
element_id: ewbid (string) - Banner's HTML element ID
name: My banner (string) - Banner's name
settings (EmbeddedWebBannerSettings) - Banner's settings
disabled: false (boolean) - Banner's activity flag
created: 2021-05-05 12:00:00 - Banner's last update datetime

PopUpWebBannersList

web_banners (array[PopUpWebBanner]) - List of web banners
selection_settings (WebBannersSelectionSettings) - Applied selection settings

EmbeddedWebBannersList

web_banners (array[EmbeddedWebBanner]) - List of web banners
selection_settings (WebBannersSelectionSettings) - Applied selection settings

PopUpWebBannerCreate

name: My banner (string) - Banner's name
settings (PopUpWebBannerSettingsUpdate) - Banner's settings
disabled: false (boolean, optional) - Banner's activity flag

EmbeddedWebBannerCreate

name: My banner (string) - Banner's name
element_id: ewbid (string) - Banner's HTML element ID
settings (EmbeddedWebBannerSettingsUpdate) - Banner's settings
disabled: false (boolean, optional) - Banner's activity flag

PopUpWebBannerModify

name: My banner (string, optional) - Banner's name
settings (PopUpWebBannerSettingsUpdate, optional) - Banner's settings
disabled: false (boolean, optional) - Banner's activity flag

EmbeddedWebBannerModify

name: My banner (string, optional) - Banner's name
element_id: ewbid (string, optional) - Banner's HTML element ID
settings (EmbeddedWebBannerSettingsUpdate, optional) - Banner's settings
disabled: false (boolean, optional) - Banner's activity flag

GlobalFrequencyCap

max_display_count: 1 (number) - How many times banners can be displayed
type: hours (string) - One of hours, days, session
size: 2 (number, optional) - mandatory for hours (1-168) and days (1-7). Must be omited for session
enabled: false (boolean) - true if you want to apply global frequency cap

WebBannerGlobalSettings

frequency_cap (GlobalFrequencyCap) - global settings for frequency cap
page_views_count (number) - Delay in page views when to display web banners

EventSchemaItem

format (string)
name (string)
path (string)
type (string)

EventSchema

title (string)
display (array, optional)

ReportsSelectionSettings

limit: 10 (number, optional) - Limit of the number of records returned
offset: 20 (number, optional) - Offset for the records returned

Report

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - Report's unique UUID
name: My report (string) - Report's name
link: http://some.url.com/reports/embed/dashboard/asd (string) - Report's link
dashboard_id: 1 (number) - Dashboard ID
disabled: false (boolean) - Report's activity flag
created: 2021-05-05 12:00:00 - Report's last update datetime

ReportsList

reports (array[Report]) - List of reports
selection_settings (ReportsSelectionSettings) - Applied selection settings

ReportCreate

name: My report (string) - Report's name
dashboard_id: 1 (number) - Metabase dashboard ID
disabled: false (boolean, optional) - Report's activity flag

ReportModify

name: My report (string, optional) - Report's name
dashboard_id: 1 (number, optional) - Metabase dashboard ID
disabled: false (boolean, optional) - Report's activity flag

ReportOrderModify

order_index: 1 (number) - Report's order index (non-negative integer)- set it to the existing entity's order index if you want to change the ordering

OrderBy (enum)

name
created_at
author_name
last_uploaded_at

OrderDir (enum)

asc
desc

PromoCodesListsSelectionSettings

limit: 10 (number, optional) - Limit of the number of records returned
offset: 20 (number, optional) - Offset for the records returned
order_by: name (OrderBy, optional) - Ordering
order_dir: desc (OrderDir, optional) - Ordering direction
name_search: sale (string, optional) - name filtering search

PromoCodesList

id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - PromoCodesList's unique UUID
name: My sale (string) - PromoCodesList's name
created_at: 2021-05-05T12:00:00Z - PromoCodesList's creation datetime
author_id: 123 - ID of user who created the PromoCodesList
last_uploaded_at: 2021-05-05T12:00:00Z - last time when promo codes were uploaded to PromoCodesList. Can be null
promo_codes_count: 0 - How many promo codes the PromoCodesList has

PromoCodesLists

promo_codes_list (array[PromoCodesList]) - List of PromoCodesList
selection_settings (PromoCodesListsSelectionSettings) - Applied selection settings

PromoCodesListCreate

name: My code list (string) - PromoCodesList's name

PromoCodesListModify

name: New code list (string) - PromoCodesList's new name

Schedule

minute (string)
hour (string)
day (string)
month (string)
day_of_week (string)

PushNotificationSchedule

segment_ids (array[number])
schedule_type (string)
schedules (array[Schedule])

PushNotificationApplication

id (string)
android (boolean)
ios (boolean)

PushNotificationAction

app
browser
deeplink

PushNotificationChannelTest

registration_tokens (array[string])
customer_id (string)

NamedEmailAddress

email_address: we.are@meiro.io (string)
name: Mrs. Meiro (string, optional)

EmailsSchedule

segment_ids (array[number])
schedule_type (string)
schedules (array[Schedule])

UtmParameters

source: source (string, optional)
medium: medium (string, optional)
campaign: campaign (string, optional)
term: term (string, optional)
content: content (string, optional)

EmailCreate

name: My Email (string)
subject: Subject (string)
preheader: Preheader (string, optional)
from_email (NamedEmailAddress)
reply_to_email: Reply-To Email (string, optional)
content_json: content json (string)
content_html: content html (string)
utm_parameters (UtmParameters)
include_unsubscribe: true (boolean)
frequency_cap (ChannelEntityFrequencyCap, optional)

EmailUpdate

name: My Email (string, optional)
subject: Subject (string, optional)
preheader: Preheader (string, optional)
from_email (NamedEmailAddress, optional)
reply_to_email: Reply-To Email (string, optional)
content_json: content json (string, optional)
content_html: content html (string, optional)
utm_parameters (UtmParameters, optional)
include_unsubscribe: true (boolean, optional)
schedules (array[EmailsSchedule])
frequency_cap (ChannelEntityFrequencyCap, optional)

EmailChannelTest

emails (array[string])
customer_id (string)
apply_frequency_cap (boolean, optional) - When true, enforces frequency cap limits during test WhatsApp campaign sending. When false, bypasses frequency cap. Defaults to false.

TextHeaderTemplateComponent

type: text_header (string)
text: Hello {{1}} (string)
positional_parameters_count: 1 (number)
named_parameters (array[string])

TextHeaderTemplateComponentWithNamedParams

type: text_header (string)
text: Hello {{name}} (string)
positional_parameters_count: 0 (number)
named_parameters: name (array[string])

MediaHeaderFormat (enum)

image
video
document

MediaHeaderTemplateComponent

type: media_header (string)
media_format (MediaHeaderFormat)

BodyTemplateComponent

text: Get voucher for {{1}}% discount on {{2}}
positional_parameters_count: 2 (number)
named_parameters (array[string])

BodyTemplateComponentWithNamedParams

text: Get voucher for {{discount}}% discount on {{product}}
positional_parameters_count: 0 (number)
named_parameters (array[string])
- discount
- product

FooterTemplateComponent

text: Type 'STOP' for unsubscribe (string)

UrlButtonTemplateComponent

type: url_button (string)
text: Click here (string)
url: https://the.link?param={{1}} (string)
positional_parameters_count: 1 (number)

CopyCodeButtonTemplateComponent

type: copy_code_button (string)
text: Copy code (string)

FlowButtonTemplateComponent

type: flow_button (string)
text: Hit the flow (string)
flow_id: 1234 (number, optional)
flow_name: devine_flow (string, optional)
icon: DRAGON (string, optional)

CommonButtonType (enum)

phone_number
quick_reply

ButtonIcon (enum)

DOCUMENT
PROMOTION
REVIEW

CommonButtonTemplateComponent

type: common_button (string)
button_type (CommonButtonType)
text: button text (string, optional)
icon (ButtonIcon, optional)

TemplateStatus (enum)

pending
approved
rejected

TemplateCategory (enum)

MARKETING
AUTHENTICATION
UTILITY

TemplateWithPositionalParams

name: Template with positional parameters (string)
status (TemplateStatus)
language: en (string)
category (TemplateCategory)
header (TextHeaderTemplateComponent, optional)
body (BodyTemplateComponent)
footer (FooterTemplateComponent)
buttons (array[UrlButtonTemplateComponent])

TemplateWithNamedParams

name: Template with named parameters (string)
status (TemplateStatus)
language: en (string)
category (TemplateCategory)
header (TextHeaderTemplateComponentWithNamedParams, optional)
body (BodyTemplateComponentWithNamedParams)
footer (FooterTemplateComponent)
buttons (array[UrlButtonTemplateComponent])

TemplateWithAlternativeHeaderAndButton

name: Template with alternative header and buttons (string)
status (TemplateStatus)
language: en (string)
category (TemplateCategory)
header (MediaHeaderTemplateComponent, optional)
body (BodyTemplateComponentWithNamedParams)
footer (FooterTemplateComponent)
buttons (array[CommonButtonTemplateComponent])

TemplateWithCopyCodeButton

name: Template with copy code button (string)
status (TemplateStatus)
language: en (string)
category: MARKETING (string)
header (MediaHeaderTemplateComponent, optional)
body (BodyTemplateComponentWithNamedParams)
footer (FooterTemplateComponent)
buttons (array[CopyCodeButtonTemplateComponent])

TemplateWithFlowButton

name: Template with copy code button (string)
status (TemplateStatus)
language: en (string)
category: MARKETING (string)
header (MediaHeaderTemplateComponent, optional)
body (BodyTemplateComponentWithNamedParams)
footer (FooterTemplateComponent)
buttons (array[FlowButtonTemplateComponent])

PositionalTemplateParameters

header: name (array[string], optional)
body (array[string], optional)
- 40
- beer
buttons (array, optional)
- (array)
  - kozel

NamedParametersHeaderExample

name: odis (string)

NamedParametersBodyExample

discount: 40 (string)
product: beer (string)

MediaHeaderParametersExample

asset_url: https://media.com/my-media-url (string)

CopyCodeButtonParametersExample

code: the-code (string)

NamedTemplateParameters

header (NamedParametersHeaderExample, optional)
body (NamedParametersBodyExample, optional)
buttons (array, optional)
- (array)
  - kozel

MediaHeaderTemplateParameters

header (MediaHeaderParametersExample, optional)
body (NamedParametersBodyExample, optional)
buttons (array, optional)

CopyCodeButtonTemplateParameters

header (MediaHeaderParametersExample, optional)
body (NamedParametersBodyExample, optional)
buttons (array[CopyCodeButtonParametersExample])

TemplateContentWithPositionalParameters

template (TemplateWithPositionalParams)
parameters (PositionalTemplateParameters)

TemplateContentWithNamedParameters

template (TemplateWithNamedParams)
parameters (NamedTemplateParameters)

TemplateContentWithMediaHeaderParameters

template (TemplateWithAlternativeHeaderAndButton)
parameters (MediaHeaderTemplateParameters)

TemplateContentWithCopyCodeParameters

template (TemplateWithCopyCodeButton)
parameters (CopyCodeButtonTemplateParameters)

WhatsappAccount

id: account_id (string)
name: Account A (string)

WhatsappCampaignSchedule

segment_ids (array[number])
schedule_type: repetitive (string)
schedules (array[Schedule])

CampaignConsistencyStatus (enum)

consistent
missing_params
unused_params
template_not_found

WhatsappCampaignWithPositionalTemplateParameters

id: campaign_id (string)
name: Campaign A (string)
account (WhatsappAccount)
content (TemplateContentWithPositionalParameters)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 2 (number)
deleted: false (boolean)
schedules (array[WhatsappCampaignSchedule])
last_activation: 2024-02-12T12:49:09Z (string, optional)
last_activation_by: 42 (number, optional)
fresh_template (TemplateWithPositionalParams)
consistency_status (CampaignConsistencyStatus)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignWithNamedTemplateParameters

id: campaign_id (string)
name: Campaign A (string)
account (WhatsappAccount)
content (TemplateContentWithNamedParameters)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 2 (number)
deleted: false (boolean)
schedules (array[WhatsappCampaignSchedule])
last_activation: 2024-02-12T12:49:09Z (string, optional)
last_activation_by: 42 (number, optional)
fresh_template (TemplateWithNamedParams)
consistency_status (CampaignConsistencyStatus)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignWithMediaHeaderTemplateParameters

id: campaign_id (string)
name: Campaign A (string)
account (WhatsappAccount)
content (TemplateContentWithMediaHeaderParameters)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 2 (number)
deleted: false (boolean)
schedules (array[WhatsappCampaignSchedule])
last_activation: 2024-02-12T12:49:09Z (string, optional)
last_activation_by: 42 (number, optional)
fresh_template (TemplateContentWithCopyCodeParameters)
consistency_status (CampaignConsistencyStatus)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignWithCopyCodeButtonTemplateParameters

id: campaign_id (string)
name: Campaign A (string)
account (WhatsappAccount)
content (TemplateContentWithCopyCodeParameters)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 2 (number)
deleted: false (boolean)
schedules (array[WhatsappCampaignSchedule])
last_activation: 2024-02-12T12:49:09Z (string, optional)
last_activation_by: 42 (number, optional)
fresh_template (TemplateWithAlternativeHeaderAndButton)
consistency_status (CampaignConsistencyStatus)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignCreate

name: campaign name (string)
account_id: account ID (string)
template_name: Template A (string)
template_parameters (PositionalTemplateParameters)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignModify

name: campaign name (string)
template_parameters (PositionalTemplateParameters)
context_attribute_id: ctx_attribute_id (string, optional)

WhatsappCampaignModifyActivationSettings

schedules (array[WhatsappCampaignSchedule])
frequency_cap (ChannelEntityFrequencyCap)

WhatsappChannelTest

phone_numbers (array[string])
customer_id (string)

OptInEmailConfiguration

subject: Subject (string)
preheader: Preheader (string, optional)
from_email (NamedEmailAddress)
reply_to_email: Reply-To Email (string)
content_json: content json (string)
content_html: content html (string)

OptInEmailTest

emails (array[string])

BrevoProviderApiConfig

api_key: some_key (string)

InfobipProviderApiConfig

api_key: some_key (string)
account_key: some_key (string)
base_url: some_url (string)

OmniveryProviderApiConfig

primary_api_key: some_key (string)
base_url: some_url (string)

EmailProviderConfig

provider: brevo (string)
host: smtp.host (string)
port: 25 (number)
username: smtp_user (string)
password: smtp_pass (string)
use_tls: true (boolean)
provider_config: some_key (BrevoProviderApiConfig, InfobipProviderApiConfig, OmniveryProviderApiConfig, optional)

EmailUnsubscribeBlock

content_json: content json (string)
content_html: content html (string)

ManualWhatsappPhoneNumber

type: manual (string)

AutomaticWhatsappPhoneNumber

type: automatic (string)
country_code: CZ (string)

WhatsappBusinessAccount

One Of
- phone_number (AutomaticWhatsappPhoneNumber)
- phone_number (ManualWhatsappPhoneNumber)
name: WhatsApp display name (string)
email: our@business.com (string)
website: https://our.business.com (string, optional)

WhatsappBusinessAccountConfirmation

phone_number (string)
phone_number_id (string)
waba_id (string)

EmailTemplateCreate

name: My Email Template (string)
content_json: content json (string)
content_html: content html (string)

EmailTemplateUpdate

name: My Email (string, optional)
content_json: content json (string, optional)
content_html: content html (string, optional)

StitchingCategoryCreate

id: category_id (string)
name: My Stitching Category (string)

StitchingCategoryUpdate

name: My Stitching Category (string, optional)

ChartFunction (enum)

SUM
COUNT
AVERAGE
CARDINALITY

ChartType (enum)

LINE
FUNNEL

ChartFrontendSettings

color: blue

ChartDataDimension

dimension_index: 1 (number)
dimension_type: INTEGER (string)
dimension_id: data_id (string)

ChartTimestampDimension

dimension_index: 0 (number)
dimension_type: DATETIME (string)
dimension_id: timestamp_id (string)

ChartDefinition

timestamp_dimension (ChartTimestampDimension)
data_dimension (ChartDataDimension)
attribute_id: attribute_id (string) - Attribute ID

ChartData

funnel_group_id: 0eccae6f-2214-4590-9d99-1edef7088ab1 (string) - Funnel Group's unique UUID
definition (ChartDefinition)
description: description (string)
name: name (string)
function (ChartFunction)
modified_by: 1 (number)
frontend_settings (ChartFrontendSettings)
id: 5961a5ae-0003-4c4d-824e-d8d2145b23a2 (string) - Funnel's unique UUID
modified: 2024-02-12T12:49:09.390070 (string)
created: 2024-02-12T12:49:09.390069 (string)
type (ChartType)

Chart

chart (ChartData) - Funnel chart

ChartList

charts (array[ChartData]) - List of charts

TrashedChartList

trashed_charts (array[ChartData]) - List of trashed charts

FunnelChartAttribute

id: attribute_id (string)
timestamp_dimension_id: timestamp_dimension_id (string)
data_dimension_id: data_dimension_id (string)
data_dimension_title: data_dimension_title (string)

LineChartAttribute

id: attribute_id (string)
timestamp_dimension_id: timestamp_dimension_id (string)
data_dimension_id: data_dimension_id (string)

ChartCreate

name: My Updated Funnel Name (string)
description: My Updated Funnel (string, optional)
frontend_settings: {} (string, optional) - optional (json)
data (array[FunnelChartAttribute], LineChartAttribute) - List of FunnelChartAttribute or LineChartAttribute
function: SUM (ChartFunction)
type: LINE (ChartType)

ChartUpdate

name: My Updated Funnel Name (string, optional)
function: SUM (ChartFunction, optional)
description: My Updated Funnel (string, optional)
frontend_settings: {} (string, optional) - optional (json)
data (LineChartAttribute, array[FunnelChartAttribute], optional) - List of FunnelChartAttribute or LineChartAttribute

ChartMove

order_index: 1 (number, required)

ChartClone

funnel_group_id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - Funnel Group UUID

FunnelGroupCreate

name: My Funnel Group (string, required)
disabled: true (boolean, optional)

FunnelGroupUpdate

name: My Updated Funnel Group (string, optional)
disabled: false (boolean, optional)

FunnelGroupMove

order_index: 1 (number, required)

JourneyCreate

name: My Journey (string, required)
description: description (string, optional)

JourneyUpdate

name: My Updated Journey (string, optional)
description: description (string, optional)

JourneyActivate

start_datetime (string, optional)
end_datetime (string, optional)
activate_now (boolean, optional)

JourneyNodeCreate

previous_journey_node_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
previous_journey_node_path: 0 (number)
node_type: entry (JourneyNodeType)
settings ( EntryOnEventNodeSettings, EntryOnSegmentNodeSettings, FlowConditionNodeSettings, FlowSplitNodeSettings, FlowWaitDelayNodeSettings, FlowWaitSlotNodeSettings, ActivateEmailNodeSettings, ActivatePushNodeSettings, ActivateWhatsappNodeSettings, ActivateWebhookNodeSettings optional)

JourneyNodeSwapPaths

path_id_a: 1 (number)
path_id_b: 2 (number)

JourneyNodeDeletePath

path_id: 1 (number)

JourneyNodeUpdate

previous_journey_node_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string, optional)
previous_journey_node_path: 0 (number, optional)
settings ( EntryOnEventNodeSettings, EntryOnSegmentNodeSettings, FlowConditionNodeSettings, FlowSplitNodeSettings, FlowWaitDelayNodeSettings, FlowWaitSlotNodeSettings, ActivateEmailNodeSettings, ActivatePushNodeSettings, ActivateWhatsappNodeSettings, ActivateWebhookNodeSettings optional)

JourneyStatus (enum)

active
draft
passive
pending

JourneyData

id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
name: My Journey (string)
description: My description (string, optional)
created: 2024-02-12T12:49:09Z (string)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 1 (number)
deleted: false (boolean)
status: draft (JourneyStatus)
start_datetime: 2024-02-12T12:49:09Z (string, optional)
end_datetime: 2024-02-12T12:49:09Z (string, optional)
nodes (array[JourneyNodeData])
lifetime_statistics (JourneyLifetimeStatisticsData, optional)

Journey

journey (JourneyData) - Journey

JourneyList

journeys (array[JourneyData]) - List of journeys

TrashedJourneyList

trashed_journeys (array[JourneyData]) - List of trashed journeys

JourneyNodeType (enum)

activate_email
activate_push
activate_whatsapp
activate_webhook
entry
flow_condition
flow_split
flow_wait_delay
flow_wait_slot

EntryNodeType (enum)

event
segment

EventStringOperation (enum)

equals
not_equal
contains
not_contain

EventStringListOperation (enum)

equals_any_of
not_equal_any_of
contains_any_of
not_contain_any_of

EventNumberOperation (enum)

equals
not_equal
lower_than
greater_than

EventNumberListOperation (enum)

equals_any_of
not_equal_any_of

EventNumberRangeOperation (enum)

between

EventDateOperation (enum)

exactly
since
until

EventDateRangeOperation (enum)

since_until

EventDateMatchOperation (enum)

match_current_day
match_current_month
match_current_year

EventStringConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: contains (EventStringOperation)
value: meiro.io (string)

EventStringListConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: equals_any_of (EventStringListOperation)
values: ["meiro.io"] (array[string])

EventNumberConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: equals (EventNumberOperation)
value: 1 (number)

EventNumberListConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: equals_any_of (EventNumberListOperation)
values: [1] (array[number])

EventNumberRangeConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: between (EventNumberRangeOperation)
min_value: 1 (number)
max_value: 2 (number)

EventDateConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: exactly (EventDateOperation)
value: 2024-02-12T12:49:09Z (string)

EventDateRangeConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: since_until (EventDateRangeOperation)
min_value: 2024-02-12T12:49:09Z (string)
max_value: 2024-02-12T13:49:09Z (string)

EventDateMatchConditionsOperation

parameter_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operation: match_current_day (EventDateMatchOperation)

EntryOnEventNodeSettings

type: event (EntryNodeType)
event_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
operator: and (string)
conditions_operation (array[ EventStringConditionsOperation, EventStringListConditionsOperation, EventNumberConditionsOperation, EventNumberListConditionsOperation, EventNumberRangeConditionsOperation, EventDateConditionsOperation, EventDateRangeConditionsOperation, EventDateMatchConditionsOperation])

EntryOnSegmentNodeSettings

schedules (array[Schedule])
segment_id: 1 (number)
type: event (EntryNodeType)

FlowConditionNodeSettings

paths (object)

FlowSplitNodeSettings

paths (object)

FlowWaitDelayNodeSettings

delay: 300 (number)

FlowWaitSlotNodeFrequency (enum)

daily
weekly
monthly

FlowWaitSlotNodeSlot

from: 00:00:00 (string)
to: 01:00:00 (string)
every: 1 (number)

FlowWaitSlotNodeSettings

timezone: UTC+0 (London) (string)
frequency: daily (FlowWaitSlotNodeFrequency)
slots (array[FlowWaitSlotNodeSlot])

ActivateEmailNodeSettings

campaign_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c

ActivatePushNodeSettings

campaign_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c

ActivateWhatsappNodeSettings

campaign_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c

ActivateWebhookNodeSettings

method: POST (string)
url: https://www.meiro.io/ (string)
headers (object)
body: body (string)

JourneyNodeData

id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
previous_journey_node_id: ba280b31-ba06-442d-ba1f-2c0dde5a691c (string)
previous_journey_node_path: 0 (number)
created: 2024-02-12T12:49:09Z (string)
modified: 2024-02-12T12:49:09Z (string)
modified_by: 1 (number)
deleted: false (boolean)
node_type: entry (JourneyNodeType)
settings ( EntryOnEventNodeSettings, EntryOnSegmentNodeSettings, FlowConditionNodeSettings, FlowSplitNodeSettings, FlowWaitDelayNodeSettings, FlowWaitSlotNodeSettings, ActivateEmailNodeSettings, ActivatePushNodeSettings, ActivateWhatsappNodeSettings, ActivateWebhookNodeSettings optional)