QA Data Return API
Stella Connect offers a QA Data Return API endpoint, allowing you to retrieve QA reviews programmatically into your own systems.
Requesting Data
You can retrieve reviews from any time period for which you have been using Stella Connect QA, 1,000 records max.
Default time period
There is no default QA Data Return time period. If you do not specify a time period or filter by sequence id then Data Return will retrieve all data starting from the first record, max 1000 records.
Specifying time periods
To request data from a specific time period, include optional parameters in your request.
- Date Parameters
- created_at_gte ; i.e. greater than or equal to created at date
- created_at_lte; i.e. less than or equal to created at date
- Date Formats
- created_at_gte and created_at_lte should be submitted in ISO_8601 format, with an appropriate timezone offset from UTC. Specifically: YYYY-MM-DDTHH:MM:SS±HH:MM
- Example: Midnight, Tuesday, December 20th, 2019 Eastern Standard Time would be 2019-12-20T00:00:00-05:00
Sequence ID Filter
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 the return of updated data.
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; i.e. after sequence id number
- Example: ?after=1000
Data return
All data returned will be in JSON format.
Comments
0 comments
Please sign in to leave a comment.