Skip to main content
GET
/
api
/
v1
/
public
/
audits
List Audits
curl --request GET \
  --url https://api.tryhikoo.com/api/v1/public/audits \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "website_id": 123,
    "overall_score": 123,
    "max_possible_score": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "number_of_audited_pages": 123,
    "language": "en"
  }
]

Authorizations

Authorization
string
header
required

Personal API key created in the dashboard (Settings > API keys).

Headers

authorization
string | null

Bearer <api_key>

X-MCP-Secret
string | null

Query Parameters

website_id
integer
required

Target website id

Response

Successful Response

id
integer
required
website_id
integer
required
status
enum<integer>
required
Available options:
1,
2,
3,
4
overall_score
number
required
max_possible_score
number
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
number_of_audited_pages
integer
required
language
enum<string>
default:en
Available options:
en,
fr
audit_type
enum<string> | null
Available options:
FULL,
SELECTED_PAGES