LOlocalfalcon
Reviews Analysis

List of All Reviews Analysis Reports

Allows you to retrieve the full list of all Reviews Analysis Reports within your Local Falcon account.

If more records exist than is allowed within the set limit, a value will be returned under next_token that can be used as a parameter to request the next page of results.

post/v1/reviews/

Request

  • Base URL
    https://api.localfalcon.com
  • Auth
    none declared

Request body application/x-www-form-urlencoded

api_keystring required

Your Local Falcon API key.

reviews_keystring

Used to filter the list of reports by their source. Provide the unique identifier (key) of the parent Reviews Analysis record to retrieve only the reports generated by that specific configuration.

place_idstring

Filter only results for specific platform Place ID. Supports multiple platform Place IDs, separated by commas.

frequency'one_time' | 'daily' | 'weekly' | 'two_weeks' | 'three_weeks' | 'four_weeks' | 'monthly'

Filter results based on the frequency of the analysis frequency.

limitinteger

The number of results you wish to retrieve.

next_tokenstring

This parameter is used to get the next 'page' of results. The value used with the parameter is provided from a previous response by this endpoint if more 'pages' of results exist.

Response

Successful response

codeinteger
code_descboolean
successboolean
messageboolean
parametersobject

Changes

No recorded changes to this operation across all 5 revisions of this API.