Skip to content

Commit cc57a3d

Browse files
authored
Merge pull request #297 from segmentio/repo-sync
repo sync
2 parents 88c88d2 + a116386 commit cc57a3d

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

src/getting-started/04-full-install.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -269,22 +269,17 @@ All of the basic [Segment methods](/docs/connections/spec/) have a common struct
269269
The following properties should be sent with every Track call:
270270

271271
| **Event Context** | **Property Name** | **Description** |
272-
273-
274-
- **Any Track call**:
275-
- **initiator** - *Was the event initiated by the user (“User”) or the system (“System”)?*
276-
- **display_format** - *Responsive or not (or some other indicator of the current page layout template)*
277-
- **Search Initiated or Search Results Displayed** - **[Search Parameters]** - *All search parameters, with the names being the snake case version of the internal names.*
278-
- **Search Results Displayed**: **total_result_count** - *The total number of results returned that match the search parameters. This number represents the number of results that could be returned to the user even if only a subset of those were actually returned (e.g., if results are paginated).*
279-
- **Paginated List Displayed**:
280-
- **total_items_pages** - *The total number of pages of items available to be viewed by the user.*
281-
- **items_per_page** - *The number of possible items in each page of items (e.g., if the UI is showing 50 search results per page). The actual number of items in the current page may be less than this number if, for example, the system is displaying the last page of results and there aren’t enough results to fill to the page’s maximum (e.g., if there are 27 results when the page could display as many as 50).*
282-
- **current_item_page** - *The current page number being displayed to the user.*
283-
- **External Link Clicked** : **destination_url** - *The URL that the user will be taken to when clicked. *Ideally this will be the final destination (e.g., after any redirects), but only the immediate destination is likely in most cases.*
284-
- **Item List Sorted**:
285-
- **sort_column** - *The internal name of the column that was sorted on.*
286-
- **sort_direction**: *ascending or descending*
287-
272+
| ----------------- | ----------------- | --------------- |
273+
| Any Track call | `initiator` | States whether the event was initiated by the user or the system. |
274+
| Any Track call | `display_format` | Responsive or not (or some other indicator of the current page layout template)
275+
| Search Initiated or Search Results Displayed | [Search Parameters] | All search parameters, with the names being the snake case version of the internal names.
276+
| Search Results Displayed | `total_result_count` | The total number of results returned that match the search parameters. This number represents the number of results that could be returned to the user even if only a subset of those were actually returned (for example, if the results are paginated).
277+
| Paginated List Displayed | `total_items_pages` | The total number of pages of items available to be viewed by the user.
278+
| Paginated List Displayed | `items_per_page` | The number of possible items in each page of items (for example, if the UI is showing 50 search results per page). The actual number of items in the current page may be less than this number if, for example, the system is displaying the last page of results and there aren’t enough results to fill to the page’s maximum (for example, if there are 27 results when the page could display as many as 50).
279+
| Paginated List Displayed | `current_item_page` | The current page number displayed to the user.
280+
| External Link Clicked | `destination_url` | The URL that the user is taken to when clicked. Ideally, this will be the final destination (for example, after any redirects), but only the immediate destination is likely in most cases.
281+
| Item List Sorted | `sort_column` | The internal name of the column that was sorted.
282+
| Item List Sorted | `sort_direction` | Whether the items sort in ascending or descending order.
288283

289284
### How to call Track
290285

0 commit comments

Comments
 (0)