beacon 0.0.1

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

Resources

event

Operations

Method and Path Description
GET /events/:discriminator

Headers

No headers

Imports

http://www.apidoc.me/flow/common/latest/service.json

Enums

No enums

Models

browser

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

The user agent of the browser

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
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 -

The current visit of the user from the browser. A visit is a rolling 30 minute window of user activity. A visit expires after 30 minutes of inactivity.

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.

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

cart_add

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

The session of the user from the browser

visitor visitor_reference Yes -

The current visit of the user from the browser. A visit is a rolling 30 minute window of user activity. A visit expires after 30 minutes of inactivity.

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

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

cart_remove

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

The session of the user from the browser

visitor visitor_reference Yes -

The current visit of the user from the browser. A visit is a rolling 30 minute window of user activity. A visit expires after 30 minutes of inactivity.

item_number string Yes -

The Flow item number

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

geo

Example Json: Minimal | Full
Field Type Required? Default Description
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
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

pageview

Example Json: Minimal | Full
Field Type Required? Default Description
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 -

The current visit of the user from the browser. A visit is a rolling 30 minute window of user activity. A visit expires after 30 minutes of inactivity.

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

price

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

currency string Yes -

session_reference

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

session_upserted

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

The session of the user from the browser

organization io.flow.common.v0.models.organization_reference:0.3.28 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

transaction

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

The session of the user from the browser

visitor visitor_reference Yes -

The current visit of the user from the browser. A visit is a rolling 30 minute window of user activity. A visit expires after 30 minutes of inactivity.

number string Yes -

The order number or id

revenue price Yes -

The total order cost

geo geo No -

Geographic information for 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

transaction_item

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

The Flow item number

price price Yes -

The price in the base currency of the organization

quantity long Yes -

visit_upserted

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

The id of the current visit

session session_reference No -

The session of the user from the browser

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

visitor_reference

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

Unions

event

Example Json: Minimal | Full
  • Type discriminator: discriminator
pageview
cart_add
cart_remove
transaction
visit_upserted
session_upserted
browser_error