Use coupon “FREE20” to claim 20% off on WhooX monthly plans and even yearly plans. You can use this coupon when registering for the first time or even if you’re renewing your WhooX subscription.

Reports

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET
https://whoox.com/api/v1/reports

Request example:

curl --location --request GET 'https://whoox.com/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: url for URL. Defaults to: url.
project
optional string
The project name.
result
optional string
The report result. Possible values are: good for Good, decent for Decent, bad for Bad.
sort_by
optional string
Sort by. Possible values are: id for Date created, generated_at for Date generated, url for URL, result for Result. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET
https://whoox.com/api/v1/reports/{id}

Request example:

curl --location --request GET 'https://whoox.com/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST
https://whoox.com/api/v1/reports

Request example:

curl --location --request POST 'https://whoox.com/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Description
url
required string
The webpage's URL.
privacy
optional integer
Report page privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password. Defaults to: 1.
password
optional string
The password for the report page. Only works with privacy set to 2.
Update

API endpoint:

PUT PATCH
https://whoox.com/api/v1/reports/{id}

Request example:

curl --location --request PUT 'https://whoox.com/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
privacy
optional integer
Report page privacy. Possible values are: 0 for Public, 1 for Private, 2 for Password.
password
optional string
The password for the report page. Only works with privacy set to 2.
results
optional integer
Update the report results. Possible values are: 0 for No, 1 for Yes. Defaults to: 0.
Delete

API endpoint:

DELETE
https://whoox.com/api/v1/reports/{id}

Request example:

curl --location --request DELETE 'https://whoox.com/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'