Properties
Last updated
Last updated
A property is a configuration that will be used for your reports. It contains all the information regarding the website to scan, the number of pages to visit, the country from where the scan will run, etc...
You can create a property by calling the endpoint.
Please find an example of the body of a property
For more information, please check the API documentation.
As mentioned in the API documentation, you can get the summary of its latest reports by adding with[]=latest_reports
as query params.
As mentioned in the API documentation, properties can be filtered in many ways. For example, if you want to retrieve all properties created in January 2025
.
Every time a property is edited, a new report will run. You can omit this by setting skip_report
to true
in your query param.
You can retrieve a property by calling the endpoint.
You can retrieve a list of properties by calling the endpoint.
To edit a property, you will need the property ID. Edit a property by calling the endpoint.
To delete a property, you will need the property ID. Delete a property by calling the endpoint.