[Milestone]: Polish Entrata Reports Data Processing, Request, and Response
No due date
0% complete
The Entrata API's /reports
endpoint works differently than other endpoints in that the request method parameters are not explicitly defined by the API, but are instead defined internally and must be retrieved via the getReportInfo
/reports
method.
The process for data retrieval for any particular report is as follows:
- Pick a report from the available rep…
The Entrata API's /reports
endpoint works differently than other endpoints in that the request method parameters are not explicitly defined by the API, but are instead defined internally and must be retrieved via the getReportInfo
/reports
method.
The process for data retrieval for any particular report is as follows:
- Pick a report from the available reports:
getReportList
method - Retrieve the report's latest version via
getReportList
's results (or in the case of thepre_lease
report override and use version1.2
) - Review the report's information regarding its method's filter parameters via
getReportInfo
- Review and explore the report's filter parameters and define the necessary request body structure and default values
- Create and R function with arguments representing the various filter parameters available. Explicitly explain any assumptions made here.
- Perform the initial request to the
getReportData
method to receive aqueue_id
(Perform Request > Parse Response JSON Body > Extract Queue ID) - Using the
queue_id
, perform a request against the/queue
endpoint'sgetResponse
method, including necessary retry logic to poll this endpoint until data becomes available. - Once have report data, parse and extract the dataset(s) from the response (note that each report will be handled differently)