LOlocalfalcon
Scans & Reports

List of All Scan Reports

Allows you to retrieve a list of all Scan Reports performed by 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/reports/

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.

limitinteger

The number of results you wish to retrieve.

start_datestring

A lower limit (oldest) date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

end_datestring

Upper limit (newest) date you wish to retrieve. Expects date formatted as MM/DD/YYYY.

place_idstring

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

keywordstring

Filter only results similar to specified keyword (loose match).

grid_size'3' | '5' | '7' | '9' | '11' | '13' | '15' | '17' | '19' | '21'

Filter only for specific grid sizes.

campaign_keystring

Filter only for scans from a specific Campaign.

platformstring

Filter only results for specific Platforms. Expects either one or multiple values of aimode, apple, chatgpt, gaio, gemini, google, grok; separated by commas.

fieldsstring

This parameter is used to target specific fields for the API to return. Expects single or comma delimited values of available data that the endpoint normally returns.

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.