Audits

Retrieve all

GET https://swissseo.eu/api/audits/
curl --request GET \
--url 'https://swissseo.eu/api/audits/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 74, "website_id": 28, "domain_id": 0, "user_id": 1, "uploader_id": "f528764d624db129b32c21fbca0cb8d6", "host": "example.com", "url": "https://example.com", "ttfb": 0.3, "response_time": 500, "average_download_speed": 200, "page_size": 5000, "is_https": true, "is_ssl_valid": true, "http_protocol": "2", "title": "Example title", "meta_description": "Example description.", "meta_keywords": "example, keywords", "data": {...}, "issues": { "major": [], "moderate": { "meta_charset": [ "missing" ], "is_http2": [ "invalid" ], "external_links": [ "too_many" ] }, "minor": { "deprecated_html_tags": [ "existing" ], "header_server": [ "existing" ], "inline_css": [ "existing" ], "unsafe_external_links": [ "existing" ], "non_deferred_scripts": [ "existing" ] }, "potential_major_issues": 11, "potential_moderate_issues": 14, "potential_minor_issues": 15, "total_tests": 40, "passed_tests": 32 }, "settings": { "is_public": 1, "password": "$2y$10$eNkOWNTptDV.Ye4v28FmO.nCWqus5SE.mYBUSzajujKfk/NNehXxe", "audit_check_interval": 21600 }, "notifications": [ 1 ], "score": 90, "total_issues": 10, "major_issues": 4, "moderate_issues": 1, "minor_issues": 5, "total_refreshes": 10, "refresh_error": null, "next_refresh_datetime": null, "last_refresh_datetime": "2024-12-08 18:50:46", "expiration_datetime": "2025-03-08 18:50:45", "last_datetime": "2024-12-11 03:00:03", "datetime": "2024-11-22 03:10:46" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://swissseo.eu/api/audits?&page=1", "last": "https://swissseo.eu/api/audits?&page=1", "next": null, "prev": null, "self": "https://swissseo.eu/api/audits?&page=1" } }

Retrieve one

GET https://swissseo.eu/api/audits/{audit_id}
curl --request GET \
--url 'https://swissseo.eu/api/audits/{audit_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 74, "website_id": 28, "domain_id": 0, "user_id": 1, "uploader_id": "f528764d624db129b32c21fbca0cb8d6", "host": "example.com", "url": "https://example.com", "ttfb": 0.3, "response_time": 500, "average_download_speed": 200, "page_size": 5000, "is_https": true, "is_ssl_valid": true, "http_protocol": "2", "title": "Example title", "meta_description": "Example description.", "meta_keywords": "example, keywords", "data": {...}, "issues": { "major": [], "moderate": { "meta_charset": [ "missing" ], "is_http2": [ "invalid" ], "external_links": [ "too_many" ] }, "minor": { "deprecated_html_tags": [ "existing" ], "header_server": [ "existing" ], "inline_css": [ "existing" ], "unsafe_external_links": [ "existing" ], "non_deferred_scripts": [ "existing" ] }, "potential_major_issues": 11, "potential_moderate_issues": 14, "potential_minor_issues": 15, "total_tests": 40, "passed_tests": 32 }, "settings": { "is_public": 1, "password": "$2y$10$eNkOWNTptDV.Ye4v28FmO.nCWqus5SE.mYBUSzajujKfk/NNehXxe", "audit_check_interval": 21600 }, "notifications": [ 1 ], "score": 90, "total_issues": 10, "major_issues": 4, "moderate_issues": 1, "minor_issues": 5, "total_refreshes": 10, "refresh_error": null, "next_refresh_datetime": null, "last_refresh_datetime": "2024-12-08 18:50:46", "expiration_datetime": "2025-03-08 18:50:45", "last_datetime": "2024-12-11 03:00:03", "datetime": "2024-11-22 03:10:46" } }

Create

POST https://swissseo.eu/api/audits
Parameters Details Description
type Optional String Allowed values: single, sitemap, bulk, html
url Optional String Available when: type = single, sitemap, html
urls Optional String Available when: type = bulk
domain_id Optional Integer -
password Optional String -
is_public Optional Boolean -
check_interval_seconds Optional Integer Allowed values: 21600, 43200, 86400, 259200, 432000, 864000, 1296000, 2592000 (seconds)
notifications Optional Array Notification handler ids
curl --request POST \
--url 'https://swissseo.eu/api/audits' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=https://example.com/' \
{ "data": { "ids": [1] } }

Update

POST https://swissseo.eu/api/audits/{audit_id}
Parameters Details Description
domain_id Optional Integer -
password Optional String -
is_public Optional Boolean -
check_interval_seconds Optional Integer Allowed values: 21600, 43200, 86400, 259200, 432000, 864000, 1296000, 2592000 (seconds)
notifications Optional Array Notification handler ids
curl --request POST \
--url 'https://swissseo.eu/api/audits/{audit_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_public=0' \
{ "data": { "id": 1 } }

Delete

DELETE https://swissseo.eu/api/audits/{audit_id}
curl --request DELETE \
--url 'https://swissseo.eu/api/audits/{audit_id}' \
--header 'Authorization: Bearer {api_key}' \