Analytics KPIs for a single location over a date range.
Changed onReturns overview review analytics (KPIs) for a location. Two sibling routes return a time-series timeline and a per-site breakdown.
Request
- Base URLhttps://listingsapi.com
- Auth
- API key in header Authorization
- or API key in header X-RapidAPI-Key and API key in header X-RapidAPI-Host
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Location ID, a raw numeric database ID (e.g. 1800289) or its Base64-encoded Relay ID (e.g. TG9jYXRpb246MTgwMDI4OQ==).
Query parameters
Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route.
End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.
Response
Successful response
Changes
- breaking
added to the response body
oneOflist for the response status - info
removed from the response body
oneOflist for the response status
- breaking
- breaking
added to the response body
oneOflist for the response status - breaking
the response's body type changed from
objectto no type for status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking