Description:
Retrieve audit data.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl https://api.semstorm.com/api-v3/audits/audit/_AUDIT_ID_.json?services_token=__ACCESS_TOKEN__

Output:

"audit_info": { "id": _AUDIT_ID_, "uid": "123", "parent_id": "0", "title": "Example audit", "url": "example.com", "device": "desktop", "audit_type": "lighthouse", "audit_settings": { (...) }, "status": "ready", "created": "1523956574", "updated": "1523956598", "type": "", "result_overall": "45" }, "audit_data": { (...) }

Description:
Create audits.

Errors:
Access: Account dont have permission to create audits. - Your account doesnt have access to creating audits via api.
Limit: You dont have enough tokens. Your new audits require need tokens, while you have current. - You have reached your monthly limit for audits.
Request: Empty 'device' field.
Request: Invalid 'device' field
Request: No 'audit_settings' array or 'profile_id' field.
Request: Choose 'audit_settings' or 'profile_id' - cannot use both.
Request: Invalid audit name defined in 'audits_settings' array.
Request: Invalid setting key in audit name in 'audits_settings' array.
Request: Invalid setting key value in audit name in 'audits_settings' array.
Request: Invalid 'profile_id' field.
Request: No 'keywords' array or 'urls' array, define at least one.
Request: Empty 'keywords_options' field.
Request: Invalid 'keywords' value.
Request: Location decoding error.
Request: Location not found.
Request: Empty 'engine' field in keywords options.
Request: Empty 'country' field in keywords options.
Request: Invalid 'engine' field.
Request: Invalid 'country' field.
Request: Invalid 'urls' value.

PHP example code:

Curl:

curl -X POST -d '{ "urls": ["example.com"], "device": ["desktop"], "profile_id": 123 }' https://api.semstorm.com/api-v3/audits/audit.json?services_token=__ACCESS_TOKEN__

Output:

"cost": 2, "left": 998, "urls": { "123456": { "123457": "123457", "123458": "123458" } }

Description:
Delete audit. Warning! Deletion of audit is irreversable, so use with caution.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl -X DELETE https://api.semstorm.com/api-v3/audits/audit/_AUDIT_ID_.json?services_token=__ACCESS_TOKEN__

Output:

[ true ]

Description:
Refresh audit.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl -X POST -d '{ "id": 1234 }' https://api.semstorm.com/api-v3/audits/audit/refresh.json?services_token=__ACCESS_TOKEN__

Output:

{ "cost": 1, "left": 4999, "refresh": {"1234": "1234"} }

Description:
Refresh audit.

Errors:
Request: No id parameter.
Request: No title parameter.
Request: "id" is invalid.
Request: Cannot clone audit which is not finished.
Request: Cannot clone single audit, select audit group from front page.
Request: You dont have enough tokens. This audit require need tokens to clone, while you have current.

PHP example code:

Curl:

curl -X POST -d '{ "id": 1234, "title": "clone example" }' https://api.semstorm.com/api-v3/audits/audit/clone.json?services_token=__ACCESS_TOKEN__

Output:

{ "cost": 1, "left": 4999, "clone": {"1234": { "1235": "1235", "1236": "1236" } } }

Description:
Retrieve audits list.

Errors:
Request: "parent_id" is invalid.

PHP example code:

Curl:

curl -X POST -d '{ "parent_id": 123 }' https://api.semstorm.com/api-v3/audits/audit/list.json?services_token=__ACCESS_TOKEN__

Output:

[ { "id": "1234", "uid": "321", "parent_id": "123", "title": "example", "url": "example.com", "device": "desktop", "audit_type": "pagespeed", "audit_settings": { (...) }, "status": "ready", "created": "1522059489", "updated": "1522135027", "type": "audit", "result_overall": "85" }, (...) ]

Description:
Retrieve audits types with possible configuration.
Note that this endpoint returns only types accessible for account which making a call, so results may vary between different account.

Errors:

PHP example code:

Curl:

curl -X POST -d '{ "parent_id": 123 }' https://api.semstorm.com/api-v3/audits/audit/settings.json?services_token=__ACCESS_TOKEN__

Output:

{ "lighthouse": { "title": "Google Lighthouse", "settings": { (...) } }, (...) }

Description:
Retrieve audit profile settings.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl https://api.semstorm.com/api-v3/audits/profile/_PROFILE_ID_.json?services_token=__ACCESS_TOKEN__

Output:

"id": _PROFILE_ID_, "uid": "123", "title": "example profile", "types": [ "lighthouse", "pagespeed" ], "settings": { "lighthouse": { (...) }, "pagespeed": { (...) }, }

Description:
Retrieve audit profile settings.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl https://api.semstorm.com/api-v3/audits/profile/_PROFILE_ID_.json?services_token=__ACCESS_TOKEN__

Output:

{ "id": _PROFILE_ID_ }

Description:
Update audit profile settings.

Errors:
Request: "id" is invalid.
Request: Field 'settings' must be array.
Request: Invalid audit name defined in 'audits_settings' array.
Request: Invalid setting key in audit name in 'audits_settings' array.
Request: Invalid setting key value in audit name in 'audits_settings' array.

PHP example code:

Curl:

curl -X PUT -d '{"title": "example profile"}' https://api.semstorm.com/api-v3/audits/profile/_PROFILE_ID_.json?services_token=__ACCESS_TOKEN__

Output:

"id": _PROFILE_ID_, "uid": "123", "title": "example profile", "types": [ "lighthouse", "pagespeed" ], "settings": { "lighthouse": { (...) }, "pagespeed": { (...) }, }

Description:
Delete audit profile.

Errors:
Request: "id" is invalid.

PHP example code:

Curl:

curl -X DELETE https://api.semstorm.com/api-v3/audits/audit/_PROFILE_ID_.json?services_token=__ACCESS_TOKEN__

Output:

[ true ]

Description:
Retrieve audit profiles list.

Errors:

PHP example code:

Curl:

curl -X POST -d '{}' https://api.semstorm.com/api-v3/audits/audit/list.json?services_token=__ACCESS_TOKEN__

Output:

[ { "id": "1234", "uid": "321", "title": "example profile", "types":[ "lighthouse" ], "settings": { (...) } }, (...) ]