| userId | | type | "integer" |
|---|
| required | true |
|---|
| description | "User ID" |
|---|
|
|---|
| tourName | | description | "Tour name, such as 'gettingstarted'" |
|---|
| required | true |
|---|
| type | "string" |
|---|
|
|---|
| action | | type | "string" |
|---|
| required | true |
|---|
| enum | | "impression" |
| "hide" |
| "button-click" |
| "link-click" |
| "complete" |
|
|---|
| description | "List of possible actions that can be taken on any given step:
* impression - guider was shown
* hide - guider was dismissed/hidden before completing the tour
* button-click - a button within the guider was clicked
* link-click - a link within the guider was clicked
* complete - user had an impression on the last step of the tour (the last in the tour definition's step list)" |
|---|
|
|---|
| step | | description | "Identifies the step currently shown to the user" |
|---|
| required | true |
|---|
| type | "integer" |
|---|
|
|---|
