Filter by time or sequence
Learn how to use optional query string parameters for Data Return API endpoints.
There is no default QA Data Return time period. If you do not specify a time period or filter by sequence ID, then the API will return all data starting from the first record, up to 1,000 records.
Date filter parameters
To request data from a specific time period, you can include optional query string parameters in your request.
Creation date
The following parameters can be submitted for all Data Return endpoints:
created_at_gte— Request items created on or after the specified date.created_at_lte— Request items created on or before the specified date.
Completion date
The following parameters can be submitted for Feedback, QA Reviews, QA Audits, and QA Calibrations:
completed_at_gte— Request items completed on or after the specified date.completed_at_lte— Request items completed on or before the specified date.
Share date
The following parameters can be submitted for 1:1 Coaching Sessions only:
shared_at_gte— Request items shared on or after the specified date.shared_at_lte— Request items shared on or before the specified date.
Date formats
Date filter parameters should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC:
YYYY-MM-DDTHH:MM:SS±HH:MMExample
Midnight, Tuesday, December 20th, 2019 Eastern Standard Time:
2019-12-20T00:00:00-05:00Filter by Sequence ID
All data will have a sequence ID that can be used to filter data. Any update to an existing review will be stamped with an updated sequence ID to allow for return of data updates.
We recommend using the sequence ID to retrieve data to ensure that you have a complete and updated data set. The sequence ID filter should only be used if you can handle duplicates in your data.
Sequence ID parameters
after— Request reviews after the specified sequence ID
Example
Request reviews with a Sequence ID greater than 1,000:
?after=1000