Data Structures

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

Login

• email: you.love@meiro.io (string)
• password: secret (string)

OktaLogin

• code: 1234567890 (string)

AuthOptions

• is_credentials_login_enabled: true (boolean)
• is_okta_login_enabled: true (boolean)
• okta_auth_link: https://okta.domain/oauth2/v1/authorize?params=values (string)

Token

• token: 1234567890abcde (string)

OrderDir (enum)

• ASC
• DESC

UserOrderBy (enum)

• id
• email

UserSelectionSettings

• limit: 10 (number, optional) - Limit of the number of records returned
• offset: 20 (number, optional) - Offset for the records returned
• order_by (UserOrderBy) - Ordered variable name
• order_dir (OrderDir) - Ordering direction

Invitation

• email: you.love@meiro.io (string)

Invitation link

• user_invitation_link: url/set_password/?email=me%40meiro.io&reset_token=to.ke.n&referrer=invitation-link (string)

Forgot password

• email: you.love@meiro.io (string)

Reset password

• email: you.love@meiro.io (string)
• password: secret (string)
• token: 1234567890abcde (string)

ChangePassword

• old_password: secret (string)
• new_password: newsecret (string)

User

• email: you.love@meiro.io (string)
• id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - User's unique UUID
• deleted: false (boolean)
• sso_enabled: true (boolean)

UserList

• users (array[User]) - array of users
• selection_settings (UserSelectionSettings) - applied selection settings

User create

• email: you.love@meiro.io (string)
• password: secret (string)
• sso_enabled (boolean, optional)

User modify

• email: you.love@meiro.io (string, optional)
• password: secret (string, optional)
• sso_enabled (boolean, optional)

User create or restore

• email: you.love@meiro.io (string)
• password: secret (string)
• sso_enabled (boolean, optional)

Alert filter (object)

• json_path: {payload,url} (string) - Postgresql path (operator #>>) for filter
• operator: contains, not_contains (enum)
• value: ^[regex]$ (string) - filter by this value

Alert modify

• inactivity_time: 1234567890 (number) - send email after this much of inactivity
• emails: email1, email2 (array[string]) - array of emails where to send alerts
• filters (array[Alert filter]) - filters of event value

Alert create

• inactivity_time: 1234567890 (number) - send email after this much of inactivity
• emails: email1, email2 (array[string]) - array of emails where to send alerts
• filters (array[Alert filter]) - filters of event value
• event_type: page_view (string) - type of events, default is special value
• source: SDK (string) - source of events (SDK, fb, appsflyer, mobile, …)

Alert

• id: 41f2cc9a-f7df-4ef8-b2e1-1bd4e627639a (string) - Alert's unique UUID
• source: SDK (string) - source of events (SDK, fb, appsflyer, mobile, …)
• inactivity_time: 1234567890 (number) - send email after this much of inactivity
• emails: email1, email2 (array[string]) - array of emails where to send alerts
• event_type: page_view (string) - type of events, default is special value
• filters (array[Alert filter]) - filters of event value

Event (object)

• payload: some_json_as_string (string) - event payload json as string
• timestamp: 2017-11-19T23:40:18+00:00 (string) - ISO formatted timestamp of this event

Datasource event type

• event_type: page_view (string) - type of events, default is special value
• count_per_minute: 1,2,3,4,5,6,7,8,9,…,60 (array[number]) - count of events for each minute in last hour, the higher index the older minute

Statistics event type

• event_type: page_view (string) - type of events, default is special value
• last_timestamp: 2017-11-19T23:40:18+00:00 (string) - ISO formatted timestamp of last event
• events (array[Event]) - a list of last 5 events, plain text

Datasource (object)

• source: SDK (string) - unique source (SDK, fb, …)
• event_types (array[Datasource event type])

Statistics (object)

• source: SDK (string) - unique source (web, facebook, …)
• event_types (array[Statistics event type])

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)

Position (enum)

• top_left
• top_right
• middle
• bottom_left
• bottom_right

BannerType (enum)

• html
• image

PopupWebBanner

• id: wb_id (string)
• name: wb_name (string)
• html: <div>banner</div> (string)
• destination_url: https://meiro.io (string, optional)
• frequency_cap (FrequencyCap)
• priority: 1 (number, optional)
• position: top_left (Position, optional)
• condition (object)
• fe_settings (object)
• minimized_html (string, optional)
• minimized_position (string, optional)
• type: html (BannerType)
• minimized_type (BannerType, optional)
• display_minimized_first (boolean)
• minimized_hide_condition (object, optional)

EmbeddedWebBanner

• id: wb_id (string)
• container_dom_id: dom_id (string)
• name: wb_name (string)
• html (string)
• frequency_cap (FrequencyCap)
• destination_url: https://meiro.io (string, optional)
• priority: 1 (number, optional)
• condition (object)
• fe_settings (object)
• type: html (BannerType)

Popup web banners apply

• banners (array[PopupWebBanner])
• settings (object)

Embedded web banners apply

• banners (array[EmbeddedWebBanner])
• settings (object)

Image create data

• name: image name (string)
• data: base64_encoded_image_data (string)

Image copy data

• name: image name (string)

TestCustomerEventExtraction

• endpoint_name: sdk (string)
• event_time_extraction: reception_time (string)
• user_identifier_extraction: payload ->> 'user_id' (string)
• limit: 1000 (number)
• event_filter: payload ->> 'type' = 'page_view' (string, optional)

TestCustomerEventResult

• event_time: 2017-11-19T23:40:18Z (string, optional) - timestamp of event time
• user_identifier: we.are@meiro.io (string, optional) - user identifier
• payload: {"some": {"nested": "payload"}} (string) - payload of the event

CustomerEventExtraction

• endpoint_name: sdk (string)
• event_time_extraction: reception_time (string)
• user_identifier_extraction: payload ->> 'user_id' (string)
• event_filter: payload ->> 'type' = 'page_view' (string)
• event_id: 123e4567-e89b-12d3-a456-426614174000 (string)

CustomerEventExtractions

• since: 2017-11-19T23:40:18Z (string) - timestamp since when you want to read events
• extractions (array[CustomerEventExtraction])

CustomerEvent

• event_time: 2017-11-19T23:40:18Z (string, optional) - timestamp of event time
• user_identifier: we.are@meiro.io (string, optional) - user identifier
• payload: {"some": {"nested": "payload"}} (string) - payload of the event

EndpointEvents

• event_id: 123e4567-e89b-12d3-a456-426614174000 (string)
• events (array[CustomerEvent])

ExtractionResponse

• last_reception_time: 2017-11-19T23:40:18Z(string, optional) - reception time of the last event
• customer_events (array[EndpointEvents])