beacon 0.2.11

  • Contact: N/A
  • License: N/A

Resources

event

Operations

Method and Path Description
GET /events/:discriminator
POST /events/:discriminator

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/latest/service.json

Enums

No enums

Models

beacon_attributes

Example Json: Minimal | Full

Additional attributes for the beacon event

Field Type Required? Default Description Annotations
version string No -

beacon_experiment

Example Json: Minimal | Full

Experiment for A/B testing

Field Type Required? Default Description Annotations
key string Yes -

variant beacon_experiment_variant No -

beacon_experiment_variant

Example Json: Minimal | Full

Experiment variant. Control or variant

Field Type Required? Default Description Annotations
key string Yes -

browser

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
user_agent string No -

The user agent of the browser

referer string No -

The referring site that linked to the page

response_time_ms double No -

The time it took to load the html document. responseEnd - navigationStart. See: https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API

processing_time_ms double No -

The time it took to load dom content. domComplete - domLoading. See: https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API

load_time_ms double No -

The time it took to load the html document. loadEventEnd - loadEventStart. See: https://developer.mozilla.org/en-US/docs/Web/API/Navigation_timing_API

browser_error

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
message string Yes -

The message property from the JavaScript ErrorEvent object.

session session_reference No -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

browser browser No -

Browser information for the user

filename string No -

The filename property from the JavaScript ErrorEvent object.

lineno string No -

The lineno property from the JavaScript ErrorEvent object.

colno string No -

The colno property from the JavaScript ErrorEvent object.

stack string No -

The error.stack property from the JavaScript ErrorEvent object.

geo geo No -

Geographic information for user

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

attributes beacon_attributes No -

cart_add

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
session session_reference Yes -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

item_number string Yes -

The Flow item number

price price Yes -

The price in the base currency of the organization

quantity long Yes -

item_name string No -

The name of the item

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

geo geo No -

Geographic information for user

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

cart_remove

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
session session_reference Yes -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

item_number string Yes -

The Flow item number

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

geo geo No -

Geographic information for user

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

geo

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
country string No -

The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries

Example: CAN

currency string No -

ISO 4217 3 currency code as defined in https://api.flow.io/reference/currencies

Example: CAD

language string No -

ISO 639 2 language code as defined in https://api.flow.io/reference/languages

Example: en

locale string No -

Locale Id as defined in https://api.flow.io/reference/locales

Example: en-US

experience string No -

The ID of a specific experience to use

location

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
host string Yes -

The host of the url from window.location.host in the browser

Example: playground.storefront.com

pathname string Yes -

The pathname of the the url from window.location.pathname in the browser

Example: /products/4534475

search string No -

The search section fo the url from window.location.search

Example: ?key=value

marketing_feed_attribution

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
marketing_feed_id string Yes -

id of marketing feed

pageview

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
location location Yes -

Location data as it comes from the window.location object in the browser

session session_reference No -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

geo geo No -

Geographic information for user

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

price

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
amount double Yes -

currency string Yes -

session_attribution

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
session session_reference Yes -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

attribution_type attribution_type Yes -

Type of session attribution

created_at date-time-iso8601 No -

Date/time the event was created

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

experiment beacon_experiment No -

attributes beacon_attributes No -

session_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

session_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string No -

Represents a session created for an organization.

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

geo geo No -

Geographic information for user

browser browser No -

Browser information for the user

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

transaction

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
session session_reference Yes -

The session of the user from the browser

visitor visitor_reference No -

A session visitor is a unique identifier for our best guess as to who the individual user is interacting with Flow.

visit visit_reference No -

A session visit expires after a configurable period of inactivity (e.g. 30 minutes).

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

number string Yes -

The order number or id

revenue price Yes -

The total order cost

ip string No -

The session visitors IP address.

geo geo No -

Geographic information for user

browser browser No -

Browser information for the user

items [transaction_item] No -

shipping price No -

The shipping amount applied to order

duty price No -

The duty applied to the order

tax price No -

The tax (VAT/HST/etc) applied to the order

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

transaction_item

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
number string Yes -

The Flow item number

price price Yes -

The price in the base currency of the organization

quantity long Yes -

name string No -

The name of the product or variant (not description)

categories [string] No -

List of categories the item belongs to

visit_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

visit_upserted

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

The id of the current visit

visit_id string No -

organization io.flow.common.v0.models.organization_reference:0.7.58 No -

created_at date-time-iso8601 No -

Date the event was processed. Not required because model is shared with browser and the time from the browser cannot be trusted. Server should set timestamp before further processing

experiment beacon_experiment No -

attributes beacon_attributes No -

visitor_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

Unions

attribution_type

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
marketing_feed_attribution marketing_feed_attribution Minimal | Full

event

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
pageview pageview Minimal | Full

cart_add cart_add Minimal | Full

cart_remove cart_remove Minimal | Full

transaction transaction Minimal | Full

visit_upserted visit_upserted Minimal | Full

session_upserted session_upserted Minimal | Full

session_attribution session_attribution Minimal | Full

browser_error browser_error Minimal | Full

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].