Create a performance audit
Creates an audit and starts its first run: each page of each environment is loaded number_of_requests times from the server location, uncached and, where check_cache is set, cached as well. The answer is the audit with run.status queued; read the audit until run.status is completed or failed.
Body
The environments to test. Up to 10 items.
Fields of each item
A name for the environment, unique in the audit, such as Current host. No control characters. Up to 100 characters.
The HTTP authentication password. No control characters. Never answered. Up to 255 characters.
The HTTP authentication username that opens a protected site for the runs. No control characters. Never answered. Up to 255 characters.
The address it is served on, a full http or https URL. No control characters. Up to 255 characters.
Up to 255 characters.
How many times each page is loaded. Defaults to 5. 1 to 20.
The pages to test on each environment. Up to 20 items.
Fields of each item
Also test the page cached.
The path of the page, such as /shop/. No control characters. Up to 255 characters.
A name for the page, unique in the audit. No control characters. Up to 100 characters.
The id of the server location to test from, as an audit answers it in server_location.id. The first location when left out.
The user agent the requests carry. No control characters. The Control Panel's own when left out. Up to 255 characters.
Returns
202 The audit was created and its run is queued. Poll the operation until it finishes.
Fields of the 202 answer
At least 1.
Format: date-time.
Fields of each item
Whether an HTTP authentication username or password is set.
At least 1.
Fields of each item
The shared report's state. It never holds the link itself or the password.
Fields
When the figures the link shows were built. Format: date-time.
Whether a link made before the report existed still shows its response times and statuses.
Format: date-time.
Fields of each item
heroat_a_glanceresponse_timesgapimprovementabsolute_timeswaterfallfilmstripfull_tablegoogle_scoresdefinitionsmethodtiming_breakdownsamplesstatus_codesresponse_headersraw_lighthouse_jsonall_metricsctasimpletechnicalbothWhether the report link works.
Format: date-time.
The username the link asks for. Null while it is not protected.
The last run started through the API or MCP.
Fields
Why a failed run failed.
Format: date-time.
Format: date-time.
Format: date-time.
Null for an audit never run through the API.
queuedrunningcompletedfailednullWhere the runs are made from. Null when the location no longer exists.
Format: date-time.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | scope_required | Use a token with the scope named in scope. |
409 | location_gone | The audit's server location no longer exists. Choose another location for the audit. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
503 | temporarily_unavailable | The Control Panel could not answer just now. Nothing was started; try again shortly. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/performance-audits \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"domains": [
{
"environment": "Current host",
"url": "https://old.harbourandfinch.example.org"
},
{
"environment": "Corefinity",
"http_password": "made-up-preview-password",
"http_username": "preview",
"url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
}
],
"name": "Shop audit",
"number_of_requests": 5,
"page_types": [
{
"check_cache": true,
"path": "/",
"title": "Home"
},
{
"path": "/shop/",
"title": "Category"
}
]
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/performance-audits', [
'domains' => [
[
'environment' => 'Current host',
'url' => 'https://old.harbourandfinch.example.org',
],
[
'environment' => 'Corefinity',
'http_password' => 'made-up-preview-password',
'http_username' => 'preview',
'url' => 'https://harbourandfinch-example-com.northwind.cfstack.example.net',
],
],
'name' => 'Shop audit',
'number_of_requests' => 5,
'page_types' => [
[
'check_cache' => true,
'path' => '/',
'title' => 'Home',
],
[
'path' => '/shop/',
'title' => 'Category',
],
],
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/performance-audits', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
domains: [
{
environment: 'Current host',
url: 'https://old.harbourandfinch.example.org',
},
{
environment: 'Corefinity',
http_password: 'made-up-preview-password',
http_username: 'preview',
url: 'https://harbourandfinch-example-com.northwind.cfstack.example.net',
},
],
name: 'Shop audit',
number_of_requests: 5,
page_types: [
{
check_cache: true,
path: '/',
title: 'Home',
},
{
path: '/shop/',
title: 'Category',
},
],
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/performance-audits",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"domains": [
{
"environment": "Current host",
"url": "https://old.harbourandfinch.example.org",
},
{
"environment": "Corefinity",
"http_password": "made-up-preview-password",
"http_username": "preview",
"url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
},
],
"name": "Shop audit",
"number_of_requests": 5,
"page_types": [
{
"check_cache": True,
"path": "/",
"title": "Home",
},
{
"path": "/shop/",
"title": "Category",
},
],
},
)
data = res.json() if res.content else None{
"company_id": 1204,
"created_at": "2026-11-03T12:30:00+00:00",
"domains": [
{
"environment": "Current host",
"http_auth": false,
"url": "https://old.harbourandfinch.example.org"
},
{
"environment": "Corefinity",
"http_auth": true,
"url": "https://harbourandfinch-example-com.northwind.cfstack.example.net"
}
],
"id": 5211,
"name": "Shop audit",
"number_of_requests": 5,
"page_types": [
{
"check_cache": true,
"path": "/",
"title": "Home"
},
{
"check_cache": false,
"path": "/shop/",
"title": "Category"
}
],
"report": {
"frozen_at": null,
"legacy_link_live": false,
"password_protected": false,
"revoked_at": null,
"sections": [
{
"enabled": true,
"key": "hero",
"label": "Headline",
"tab": "simple"
},
{
"enabled": true,
"key": "at_a_glance",
"label": "At a glance",
"tab": "simple"
},
{
"enabled": true,
"key": "response_times",
"label": "Response times",
"tab": "simple"
},
{
"enabled": true,
"key": "gap",
"label": "The gap, measurement by measurement",
"tab": "simple"
},
{
"enabled": true,
"key": "improvement",
"label": "Improvement per measurement",
"tab": "simple"
},
{
"enabled": true,
"key": "absolute_times",
"label": "Absolute times, side by side",
"tab": "simple"
},
{
"enabled": true,
"key": "waterfall",
"label": "Where the time actually goes",
"tab": "simple"
},
{
"enabled": true,
"key": "filmstrip",
"label": "Loading filmstrip",
"tab": "simple"
},
{
"enabled": true,
"key": "full_table",
"label": "The full table",
"tab": "simple"
},
{
"enabled": true,
"key": "google_scores",
"label": "Google scores",
"tab": "simple"
},
{
"enabled": true,
"key": "definitions",
"label": "Definitions",
"tab": "simple"
},
{
"enabled": true,
"key": "method",
"label": "Method",
"tab": "technical"
},
{
"enabled": true,
"key": "timing_breakdown",
"label": "Timing breakdown",
"tab": "technical"
},
{
"enabled": true,
"key": "samples",
"label": "Individual samples",
"tab": "technical"
},
{
"enabled": true,
"key": "status_codes",
"label": "Status codes and redirect chains",
"tab": "technical"
},
{
"enabled": true,
"key": "response_headers",
"label": "Response headers",
"tab": "technical"
},
{
"enabled": true,
"key": "raw_lighthouse_json",
"label": "Raw Lighthouse response",
"tab": "technical"
},
{
"enabled": true,
"key": "all_metrics",
"label": "Every available metric",
"tab": "technical"
},
{
"enabled": true,
"key": "cta",
"label": "Contact Corefinity",
"tab": "both"
}
],
"shared": false,
"shared_at": null,
"username": null
},
"run": {
"error": null,
"finished_at": null,
"requested_at": "2026-11-03T12:30:00+00:00",
"started_at": null,
"status": "queued"
},
"server_location": {
"id": 12,
"name": "London"
},
"updated_at": "2026-11-03T12:30:00+00:00",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36"
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "Your account cannot create performance audits. Ask an owner of your company for access.",
"reason": "forbidden"
}{
"code": "location_gone",
"message": "This audit's server location no longer exists. Choose another server location for the audit first.",
"reason": "location_gone"
}{
"code": "invalid",
"errors": {
"domains": [
"The domains field is required."
]
},
"field": "domains",
"message": "The domains field is required.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "temporarily_unavailable",
"message": "Performance audits cannot run right now. Try again later.",
"reason": "temporarily_unavailable"
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.