Skip to content

V2BIRD-23149 survey deepPagination changes #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AnamikaBE wants to merge 1 commit into
base: master
Choose a base branch
from
Open

V2BIRD-23149 survey deepPagination changes #323

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion apiary.apib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10927,6 +10927,8 @@ Post a survey response API submits the survey response for a particular survey u
## List Responses [/v1/survey/ext/list/responses/{survey_id}{?businessNumber,page,size,sortby,sorder,includeTicketId}]
List Responses for a Survey API fetches all the responses available for a particular survey ID.

> __Note__
> - _By default, Deep Pagination with record window (page x size) greater than 100k is not supported. Either reduce the page/size combination to be less than or equal to 100k, or pass `deepPagination: true` in the request body to fetch beyond this limit._

### List Responses for a Survey [POST]

Expand All @@ -10950,12 +10952,14 @@ List Responses for a Survey API fetches all the responses available for a partic
+ Attributes
+ startDate: "MM/dd/yyyy HH:mm:ss" (string, optional) - Start date.
+ endDate: "MM/dd/yyyy HH:mm:ss" (string, optional) - End date.
+ deepPagination: false (boolean, optional) - Set to true to allow paging beyond the standard pagination limit (page x size greater than 100k). Default is false.

+ Body

{
"startDate" : "07/03/2018 06:30:00",
"endDate" : "07/23/2018 06:45:00"
"endDate" : "07/23/2018 06:45:00",
"deepPagination": true
}


Expand Down Expand Up @@ -21991,6 +21995,7 @@ Add Business Integration Mapping adds locations to integrations and set them act

# Group Change Logs

* <b>09/02/2026</b> - Added `deepPagination` flag support in the List Responses for a Survey API to allow fetching survey responses beyond the standard 100k record pagination limit.
* <b>07/03/2026</b> - Updated `mainBusinessDescription` and microsite `internalListing.description` fields in Create, Update and Get Listing APIs to be optional instead of required, with support for clearing the existing value by sending an empty string (V2BIRD-1690).
* <b>06/10/2026</b> - Updated Get Contact API to support an optional `experienceScore` boolean field in the request body (default: false). When set to true, the response includes the customer's experience score and source.
* <b>05/25/2026</b> - Added Update Custom card (PUT) and Delete Custom card (DELETE) API documentation under the Business profile custom card section.
Expand Down