Skip to content

Commit

Permalink
fix(docs): update flow event docs to match recent changes (#198) r=vl…
Browse files Browse the repository at this point in the history
…adikoff
  • Loading branch information
philbooth authored and vladikoff committed Oct 5, 2016
1 parent f23707f commit d6eb73d
Showing 1 changed file with 8 additions and 14 deletions.
22 changes: 8 additions & 14 deletions features/FxA-41-signin-funnel-metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,12 @@ in a successful flow:

|Name|Origin|Description|
|----|------|-----------|
|`flow.begin`|content|User has landed on a page that allows them to log in or sign up.|
|`flow.signup.engage`|content|User has interacted with the signup form at `/signup`.|
|`flow.signin.engage`|content|User has interacted with the login form at `/signin`.|
|`flow.force_auth.engage`|content|User has interacted with the login form at `/force_auth`.|
|`flow.signup.submit`|content|User has submitted the signup form at `/signup`. It is a valid flow for this event to be followed by `account.login`, because the content server allows users to log in from `/signup`.|
|`flow.signin.submit`|content|User has submitted the login form at `/signin`.|
|`flow.force_auth.submit`|content|User has submitted the login form at `/force_auth`.|
|`flow.${viewName}.begin`|content|User has landed on a page that allows them to sign in/up.|
|`flow.${viewName}.engage`|content|User has interacted with the form on a page that allows them to sign in/up.|
|`flow.${viewName}.submit`|content|User has submitted the form on a page that allows them to sign in/up.|
|`flow.have-account`|content|User has clicked the "Already have an account?" link on `/signup`.|
|`account.login`|auth|User’s credentials are correct.|
|`account.created`|auth|Account has been created.|
|`device.created`|auth|Device record has been created.|
|`email.sent`|auth|Confirmation email has been sent to the user.|
|`email.clicked`|auth|Request to the URL in the confirmation email has been received.|
|`account.confirmed`|auth|Login has been confirmed via email.|
Expand All @@ -101,12 +97,11 @@ in a successful flow:
For a typical successful Sync login flow,
the sequence of events would be:

* `flow.begin`
* `flow.signin.begin`
* `flow.signin.engage`
* `flow.signin.submit`
* `account.login`
* `email.sent`
* `device.created`
* `email.clicked`
* `account.confirmed`
* `account.keyfetch`
Expand All @@ -116,12 +111,11 @@ the sequence of events would be:
For a typical successful Sync signup flow,
the sequence of events would be:

* `flow.begin`
* `flow.signup.begin`
* `flow.signup.engage`
* `flow.signup.submit`
* `account.created`
* `email.sent`
* `device.created`
* `email.clicked`
* `account.verified`
* `account.keyfetch`
Expand Down Expand Up @@ -238,10 +232,10 @@ will carry the following properties:

|Property|Description|
|--------|-----------|
|`event`|The event name, e.g. `flow.engage`|
|`event`|The event name, e.g. `flow.signin.engage`|
|`time`|Unix timestamp for this event|
|`flow_id`|Unique identifier for a flow, randomly generated by the content server|
|`flow_time`|Offset in milliseconds from the `time` property of the relevant `flow.begin` event|
|`flow_time`|Offset in milliseconds from the `time` property of the relevant `flow.${viewName}.begin` event|
|`userAgent`|User agent string, parsed by the data pipeline and made available as the properties `useragentbrowser`, `useragentversion`, `useragentos`|
|`context`|Auth-broker context|
|`entrypoint`|Entry-point for the flow|
Expand Down

0 comments on commit d6eb73d

Please sign in to comment.