Skip to content

Commit 4ebb7c4

Browse files
oliwiapolecoliwiapolec
authored
feat(docs): fix form parameter name (#1635)
1 parent dc8100b commit 4ebb7c4

File tree

15 files changed

+26
-26
lines changed

15 files changed

+26
-26
lines changed

‎payloads/data-reporting/v3.5/reports-api/surveyFilter.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"surveys": [
2+
"forms": [
33
{
44
"type": "pre_chat",
55
"from": "2021-01-01T00:00:00-00:00",

‎payloads/data-reporting/v3.6/reports-api/surveyFilter.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"surveys": [
2+
"forms": [
33
{
44
"type": "pre_chat",
55
"from": "2021-01-01T00:00:00-00:00",

‎payloads/data-reporting/v3.7/reports-api/surveyFilter.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"surveys": [
2+
"forms": [
33
{
44
"type": "pre_chat",
55
"from": "2021-01-01T00:00:00-00:00",

‎src/pages/data-reporting/reports-api/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ You can authorize your calls to the Reports API using one of the following metho
7676
| `filters.tags.<string_filter_type>`<sup>**2**</sup> | No | `any` | Described below. |
7777
| `filters.sales.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
7878
| `filters.goals.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
79-
| `filters.surveys.<survey>`<sup>**4**</sup> | No | `array` | Described below. |
79+
| `filters.forms.<form>`<sup>**4**</sup> | No | `array` | Described below. |
8080
| `filters.event_types.<event_type_filter_type>`<sup>**5**</sup> | No | `any` | Described below. |
8181
| `filters.groups.<integer_filter_type>`<sup>**3**</sup> | No | `array` | An array of group IDs. |
8282
| `filters.greetings.from` | No | `string` | Filters chats started from a greeting within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. |
@@ -153,7 +153,7 @@ You can pass only one of the following values at a time: `exists`, `values` or `
153153

154154
You can pass only one of the following values at a time: `exists`, `values` or `exclude_values`.
155155

156-
**4)** `<survey>` contains the following fields:
156+
**4)** `<form>` contains the following fields:
157157

158158
- `type` (`string`) - allowed values: `pre_chat`, `post_chat`
159159
- `values` (`string[]`) - an array of answer_ids

‎src/pages/data-reporting/reports-api/v3.5/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ You can find all the requests from the Reports API v3.5 in Postman. In our colle
8484
| `filters.tags.<string_filter_type>`<sup>**2**</sup> | No | `any` | Described below. |
8585
| `filters.sales.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
8686
| `filters.goals.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
87-
| `filters.surveys.<survey>`<sup>**4**</sup> | No | `array` | Described below. |
87+
| `filters.forms.<form>`<sup>**4**</sup> | No | `array` | Described below. |
8888
| `filters.event_types.<event_type_filter_type>`<sup>**5**</sup> | No | `any` | Described below. |
8989
| `filters.groups.<integer_filter_type>`<sup>**3**</sup> | No | `array` | Array of group IDs. |
9090
| `filters.greetings.from` | No | `string` | Filters out chats started from a greeting that was sent within the time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. |
@@ -146,7 +146,7 @@ You can pass only one of the following values at a time: `exists`, `values` or `
146146

147147
You can pass only one of the following values at a time: `exists`, `values` or `exclude_values`.
148148

149-
**4)** `<survey>` contains the following fields:
149+
**4)** `<form>` contains the following fields:
150150

151151
- `type` (`string`) - allowed values: `pre_chat`, `post_chat`
152152
- `values` (`string[]`) - an array of answer_ids

‎src/pages/data-reporting/reports-api/v3.7/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can authorize your calls to the Reports API using one of the following metho
7777
| `filters.tags.<string_filter_type>`<sup>**2**</sup> | No | `any` | Described below. |
7878
| `filters.sales.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
7979
| `filters.goals.<integer_filter_type>`<sup>**3**</sup> | No | `any` | Described below. |
80-
| `filters.surveys.<survey>`<sup>**4**</sup> | No | `array` | Described below. |
80+
| `filters.forms.<form>`<sup>**4**</sup> | No | `array` | Described below. |
8181
| `filters.event_types.<event_type_filter_type>`<sup>**5**</sup> | No | `any` | Described below. |
8282
| `filters.groups.<integer_filter_type>`<sup>**3**</sup> | No | `array` | An array of group IDs. |
8383
| `filters.greetings.from` | No | `string` | Filters chats started from a greeting within the specified time range defined as <`from`,`to`>. Date & time format compatible with RFC3339 with optional resolution of microseconds, `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`. |
@@ -154,7 +154,7 @@ You can pass only one of the following values at a time: `exists`, `values` or `
154154

155155
You can pass only one of the following values at a time: `exists`, `values` or `exclude_values`.
156156

157-
**4)** `<survey>` contains the following fields:
157+
**4)** `<form>` contains the following fields:
158158

159159
- `type` (`string`) - allowed values: `pre_chat`, `post_chat`
160160
- `values` (`string[]`) - an array of answer_ids

‎src/pages/messaging/agent-chat-api/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
517517
| `filters.tags.<filter_type>` | No | `any` | |
518518
| `filters.sales.<filter_type>` | No | `any` | |
519519
| `filters.goals.<filter_type>` | No | `any` | |
520-
| `filters.surveys.<survey>` | No | `array` | **\*\*\* described below** |
520+
| `filters.forms.<form>` | No | `array` | **\*\*\* described below** |
521521
| `filters.event_types.<event_type_filter_type>` | No | `any` | **\*\*\*\* described below** |
522522
| `filters.greetings.<greetings_filter_type>` | No | `any` | **\*\*\*\*\*\* described below** |
523523
| `filters.agent_response.<agent_response_filter_type>` | No | `any` | **\*\*\*\*\*\*\* described below** |
@@ -551,7 +551,7 @@ There's only one value allowed for a single property.
551551
You can pass only one of the following values at a time: `exists`, `values` or `exclude_values`.
552552

553553
**\*\*\*)**
554-
`<survey>` contains the following fields:
554+
`<form>` contains the following fields:
555555

556556
- `from` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`
557557
- `to` (`string`) - date & time format compatible with RFC3339 with a resolution of microseconds: `YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM`

‎src/pages/messaging/agent-chat-api/rtm-reference/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
574574
| `filters.tags.<filter_type>` | No | `any` | |
575575
| `filters.sales.<filter_type>` | No | `any` | |
576576
| `filters.goals.<filter_type>` | No | `any` | |
577-
| `filters.surveys.<survey>` | No | `array` | **\*\*\*** **described below** |
577+
| `filters.forms.<form>` | No | `array` | **\*\*\*** **described below** |
578578
| `filters.event_types.<event_type_filter_type>` | No | `any` | **\*\*\*\*** **described below** |
579579
| `filters.greetings.<greetings_filter_type>` | No | `any` | **\*\*\*\*\*\*** **described below** |
580580
| `filters.agent_response.<agent_response_filter_type>` | No | `any` | **\*\*\*\*\*\*\*** **described below** |
@@ -610,7 +610,7 @@ You can pass only one of the following values at a time: `exists`, `values` or `
610610
There's only one value allowed for a single property.
611611

612612
**\*\*\*)**
613-
`<survey>` contains the following fields:
613+
`<form>` contains the following fields:
614614

615615
- `type` (`string`) - allowed values: `pre_chat`, `post_chat`
616616
- `answer_id` (`string`)

‎src/pages/messaging/agent-chat-api/v3.2/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
460460
| `filters.tags.<filter_type>` | No | `any` | |
461461
| `filters.sales.<filter_type>` | No | `any` | |
462462
| `filters.goals.<filter_type>` | No | `any` | |
463-
| `filters.surveys.<survey>` | No | `array` | **\*\*** **described below** |
463+
| `filters.forms.<form>` | No | `array` | **\*\*** **described below** |
464464
| `filters.events.types` | No | `array` | Array of [Event](/messaging/agent-chat-api/v3.2/data-structures/#events) types. Duplicates are ignored. |
465465
| `page_id` | No | `string` | |
466466
| `sort_order` **\*\*\*** | No | `string` | Default: `desc` |
@@ -479,7 +479,7 @@ The list classification is based on threads; 1 chat per 1 thread. Thus, the same
479479
There's only one value allowed for a single property.
480480

481481
**\*\*)**
482-
`<survey>` contains the following fields:
482+
`<form>` contains the following fields:
483483

484484
- `type` (`string`) - allowed values: `pre_chat`, `post_chat`
485485
- `answer_id` (`string`)

0 commit comments

Comments
 (0)