You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/kb/api-version-3/export.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ A procedure is a query and execution plan used to retrieve the data. Each object
41
41
42
42
### Fields
43
43
44
-
Select the visitor activity fields you want to export. Following are the fields that are available for visitor activity: [/../object-field-references/#visitor-activity](../../object-field-references/#visitor-activity). The value for `fields` must be an array of strings of the available fields.
44
+
Select the visitor activity fields you want to export. Following are the fields that are available for visitor activity: [../../object-field-references/#visitor-activity](../../object-field-references/#visitor-activity). The value for `fields` must be an array of strings of the available fields.
45
45
46
46
#### Abilities
47
47
@@ -75,7 +75,7 @@ Retrieves all visitor activity records with a `created_at` value that is equal o
75
75
76
76
***created_after**: Selects visitor activities that were created after the specified time. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
77
77
***created_before**: (Optional) Selects visitor activities that were created before the specified time. This value must be after the value in `created_after`. If this argument is not specified, then no upper boundary is used in the query, and all data after the `created_after` is returned. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
78
-
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all of the visitor activities belonging to any type is returned. See a list of available [Visitor Activity Types](../object-field-references.md#visitor-activity-types) in [Visitor Activity](../object-field-references.md#visitor-activity) in [Object Field References](../object-field-references.md).
78
+
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all of the visitor activities belonging to any type is returned. See a list of available [Visitor Activity Types](../../object-field-references.md#visitor-activity-types) in [Visitor Activity](../../object-field-references.md#visitor-activity) in [Object Field References](../../object-field-references.md).
79
79
***prospectOnly**: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to `false`, all visitor activities with and without a prospect are returned. The values can be `true` or `false`.
80
80
81
81
### filter_by_updated_at
@@ -86,7 +86,7 @@ Retrieves all visitor activity records with an `updated_at` value that is equal
86
86
87
87
***updated_after**: Selects visitor activities that were updated after the specified time. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
88
88
***updated_before**: (Optional) Selects visitor activities that were updated before the specified time. This value must be after the value in `updated_after`. If this argument is not specified, then no upper boundary is used in the query, and all data after the `updated_after` is returned. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
89
-
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all visitor activities belonging to any type are returned. See a list of available [Visitor Activity Types](../object-field-references.md#visitor-activity-types) in [Visitor Activity](../object-field-references.md#visitor-activity) in [Object Field References](../object-field-references.md).
89
+
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all visitor activities belonging to any type are returned. See a list of available [Visitor Activity Types](../../object-field-references.md#visitor-activity-types) in [Visitor Activity](../../object-field-references.md#visitor-activity) in [Object Field References](../../object-field-references.md).
90
90
***prospectOnly**: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to `false`, all visitor activities with and without a prospect are returned. The values can be `true` or `false`.
91
91
92
92
__NOTE:__ The range between updated_after and updated_before cannot exceed 1 year. When updated_before is not specified, the current date is used to gauge the interval.
@@ -95,7 +95,7 @@ __NOTE:__ The range between updated_after and updated_before cannot exceed 1 yea
95
95
96
96
### Fields
97
97
98
-
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#list-membership](/../object-field-references/#list-membership) The value for `fields` must be an array of strings of the available fields.
98
+
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [../../object-field-references/#list-membership](../../object-field-references#list-membership) The value for `fields` must be an array of strings of the available fields.
99
99
100
100
101
101
### Abilities
@@ -149,7 +149,7 @@ __NOTE:__ The range between created_after and created_before or updated_after an
149
149
150
150
### Fields
151
151
152
-
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#prospect](/../object-field-references/#prospect) The value for `fields` must be an array of strings of the available fields.
152
+
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#prospect](../../object-field-references/#prospect) The value for `fields` must be an array of strings of the available fields.
153
153
154
154
_**Note**_: The `grade` and `notes` fields are not available through this api.
Copy file name to clipboardExpand all lines: docs/kb/api-version-4/export.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ A procedure is a query and execution plan used to retrieve the data. Each object
41
41
42
42
### Fields
43
43
44
-
Select the visitor activity fields you want to export. Following are the fields that are available for visitor activity: [/../object-field-references/#visitor-activity](../../object-field-references/#visitor-activity). The value for `fields` must be an array of strings of the available fields.
44
+
Select the visitor activity fields you want to export. Following are the fields that are available for visitor activity: [../../object-field-references/#visitor-activity](../../object-field-references/#visitor-activity). The value for `fields` must be an array of strings of the available fields.
45
45
46
46
47
47
#### Abilities
@@ -75,7 +75,7 @@ Retrieves all visitor activity records with a `created_at` value that is equal o
75
75
76
76
***created_after**: Selects visitor activities that were created after the specified time. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
77
77
***created_before**: (Optional) Selects visitor activities that were created before the specified time. This value must be after the value in `created_after`. If this argument is not specified, then no upper boundary is used in the query, and all data after the `created_after` is returned. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
78
-
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all of the visitor activities belonging to any type is returned. See a list of available [Visitor Activity Types](../object-field-references.md#visitor-activity-types) in [Visitor Activity](../object-field-references.md#visitor-activity) in [Object Field References](../object-field-references.md).
78
+
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all of the visitor activities belonging to any type is returned. See a list of available [Visitor Activity Types](../../object-field-references.md#visitor-activity-types) in [Visitor Activity](../../object-field-references.md#visitor-activity) in [Object Field References](../../object-field-references.md).
79
79
***prospectOnly**: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to `false`, all visitor activities with and without a prospect are returned. The values can be `true` or `false`.
80
80
81
81
### filter_by_updated_at
@@ -86,7 +86,7 @@ Retrieves all visitor activity records with an `updated_at` value that is equal
86
86
87
87
***updated_after**: Selects visitor activities that were updated after the specified time. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
88
88
***updated_before**: (Optional) Selects visitor activities that were updated before the specified time. This value must be after the value in `updated_after`. If this argument is not specified, then no upper boundary is used in the query, and all data after the `updated_after` is returned. The value can be `today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, or a custom time specified in [GNU Date Input Syntax](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html) format.
89
-
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all visitor activities belonging to any type are returned. See a list of available [Visitor Activity Types](../object-field-references.md#visitor-activity-types) in [Visitor Activity](../object-field-references.md#visitor-activity) in [Object Field References](../object-field-references.md).
89
+
***type**: (Optional) Selects visitor activities of the specified types. If this argument is not specified, then all visitor activities belonging to any type are returned. See a list of available [Visitor Activity Types](../../object-field-references.md#visitor-activity-types) in [Visitor Activity](../../object-field-references.md#visitor-activity) in [Object Field References](../../object-field-references.md).
90
90
***prospectOnly**: (Optional) Selects only those visitor activities associated with a prospect. When this field is set to `false`, all visitor activities with and without a prospect are returned. The values can be `true` or `false`.
91
91
92
92
__NOTE:__ The range between updated_after and updated_before cannot exceed 1 year. When updated_before is not specified, the current date is used to gauge the interval.
@@ -96,7 +96,8 @@ __NOTE:__ The range between updated_after and updated_before cannot exceed 1 yea
96
96
97
97
### Fields
98
98
99
-
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#list-membership](/../object-field-references/#list-membership) The value for `fields` must be an array of strings of the available fields.
99
+
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [../../object-field-references/#list-membership](../../object-field-references#list-membership) The value for `fields` must be an array of strings of the available fields.
100
+
100
101
101
102
102
103
### Abilities
@@ -150,7 +151,7 @@ __NOTE:__ The range between created_after and created_before or updated_after an
150
151
151
152
### Fields
152
153
153
-
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#prospect](/../object-field-references/#prospect) The value for `fields` must be an array of strings of the available fields.
154
+
Select the prospect fields that you want to export. Following are the fields that are available for prospect: [/../object-field-references/#prospect](../../object-field-references/#prospect) The value for `fields` must be an array of strings of the available fields.
154
155
155
156
156
157
_**Note**_: The `grade` and `notes` fields are not available through this api.
0 commit comments