Endpoint Get Feedbacks
Name
get_feedbacks
Description
Related Tables
Parameters
| Parameter | Required | Options | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Ratings |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: OperatorIds |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: DepartmentIds |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: AppIds |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: StartTime The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: EndTime The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: TimezoneOffset |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: VisitorEmail |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: PageSize |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| ReferenceId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| Question |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| CreatedTime |
DT_DBTIMESTAMP
|
datetime
|
||
| AttenderEmail |
DT_WSTR
|
nvarchar(500)
|
500 | |
| RatingType |
DT_WSTR
|
nvarchar(100)
|
100 | |
| RatingValue |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Feedback |
DT_WSTR
|
nvarchar(1280)
|
1280 | |
| VisitorPhone |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorEmail |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorSupportedOperations |
DT_WSTR
|
nvarchar(50)
|
50 | |
| VisitorIp |
DT_WSTR
|
nvarchar(500)
|
500 | |
| SupportTicketId |
DT_WSTR
|
nvarchar(100)
|
100 | |
| AttenderId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderDisplayName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderType |
DT_WSTR
|
nvarchar(100)
|
100 | |
| AttenderImageUrl |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| NotesAvailable |
DT_BOOL
|
bit
|
||
| ConversationReferenceId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ConversationMode |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ConversationId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| DepartmentId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| StartTime |
DT_DBTIMESTAMP
|
datetime
|
||
| EndTime |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Zoho SalesIQ Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Feedbacks table, therefore it is better to use it, instead of accessing the endpoint directly:
| Optional Parameters | |
|---|---|
| Ratings | |
| OperatorIds | |
| DepartmentIds | |
| AppIds | |
| StartTime | |
| EndTime | |
| TimezoneOffset | |
| VisitorEmail | |
API Destination
This Endpoint belongs to the Feedbacks table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get feedbacks:
| Optional Parameters | |
|---|---|
| Ratings | |
| OperatorIds | |
| DepartmentIds | |
| AppIds | |
| StartTime | |
| EndTime | |
| TimezoneOffset | |
| VisitorEmail | |
ODBC application
Use these SQL queries in your ODBC application data source:
Read feedbacks
<p>Reads visitor feedback and ratings submitted after chat sessions. This data helps in evaluating operator performance and customer satisfaction.</p> <p>The <code>Feedbacks</code> table contains ratings and comments provided by visitors.</p>
SELECT * FROM Feedbacks
Read feedbacks with manual pagination
<p>Reads feedback records in batches to overcome API pagination limits. This example demonstrates how to retrieve data month-by-month and combine the results using <code>UNION</code> to get a complete dataset for a longer period.</p> <p>This approach is necessary when the total number of records exceeds the API's single-request limit, ensuring all data is captured by iterating through date ranges.</p>
SELECT * INTO #t1 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-01-01', EndTime='2023-02-01');
SELECT * INTO #t2 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-02-01', EndTime='2023-03-01');
SELECT * INTO #t3 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-03-01', EndTime='2023-04-01');
SELECT * INTO #t4 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-04-01', EndTime='2023-05-01');
SELECT * INTO #t5 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-05-01', EndTime='2023-06-01');
SELECT * INTO #t6 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-06-01', EndTime='2023-07-01');
SELECT * INTO #t7 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-07-01', EndTime='2023-08-01');
SELECT * INTO #t8 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-08-01', EndTime='2023-09-01');
SELECT * INTO #t9 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-09-01', EndTime='2023-10-01');
SELECT * INTO #t10 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-10-01', EndTime='2023-11-01');
SELECT * INTO #t11 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-11-01', EndTime='2023-12-01');
SELECT * INTO #t12 FROM Feedbacks WITH(OperatorIds='81565000003048017', StartTime='2023-12-01', EndTime='2024-01-01');
SELECT * FROM #t1 UNION
SELECT * FROM #t2 UNION
SELECT * FROM #t3 UNION
SELECT * FROM #t4 UNION
SELECT * FROM #t5 UNION
SELECT * FROM #t6 UNION
SELECT * FROM #t7 UNION
SELECT * FROM #t8 UNION
SELECT * FROM #t9 UNION
SELECT * FROM #t10 UNION
SELECT * FROM #t11 UNION
SELECT * FROM #t12;
get_feedbacks endpoint belongs to
Feedbacks
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read feedbacks
<p>Reads visitor feedback and ratings submitted after chat sessions. This data helps in evaluating operator performance and customer satisfaction.</p> <p>The <code>Feedbacks</code> table contains ratings and comments provided by visitors.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Feedbacks';
EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];
Read feedbacks with manual pagination
<p>Reads feedback records in batches to overcome API pagination limits. This example demonstrates how to retrieve data month-by-month and combine the results using <code>UNION</code> to get a complete dataset for a longer period.</p> <p>This approach is necessary when the total number of records exceeds the API's single-request limit, ensuring all data is captured by iterating through date ranges.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * INTO #t1 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-01-01'', EndTime=''2023-02-01'');
SELECT * INTO #t2 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-02-01'', EndTime=''2023-03-01'');
SELECT * INTO #t3 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-03-01'', EndTime=''2023-04-01'');
SELECT * INTO #t4 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-04-01'', EndTime=''2023-05-01'');
SELECT * INTO #t5 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-05-01'', EndTime=''2023-06-01'');
SELECT * INTO #t6 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-06-01'', EndTime=''2023-07-01'');
SELECT * INTO #t7 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-07-01'', EndTime=''2023-08-01'');
SELECT * INTO #t8 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-08-01'', EndTime=''2023-09-01'');
SELECT * INTO #t9 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-09-01'', EndTime=''2023-10-01'');
SELECT * INTO #t10 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-10-01'', EndTime=''2023-11-01'');
SELECT * INTO #t11 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-11-01'', EndTime=''2023-12-01'');
SELECT * INTO #t12 FROM Feedbacks WITH(OperatorIds=''81565000003048017'', StartTime=''2023-12-01'', EndTime=''2024-01-01'');
SELECT * FROM #t1 UNION
SELECT * FROM #t2 UNION
SELECT * FROM #t3 UNION
SELECT * FROM #t4 UNION
SELECT * FROM #t5 UNION
SELECT * FROM #t6 UNION
SELECT * FROM #t7 UNION
SELECT * FROM #t8 UNION
SELECT * FROM #t9 UNION
SELECT * FROM #t10 UNION
SELECT * FROM #t11 UNION
SELECT * FROM #t12;';
EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];
get_feedbacks endpoint belongs to
Feedbacks
table(s), and can therefore be used via those table(s).