CorefinityCorefinityDocs
Open the Control PanelControl Panel
Performance audits · 11 of 14

Start a performance audit run

Runs every page of the audit again with its saved settings, as Refresh All does in the Control Panel. One run at a time: read the audit until run.status is completed or failed.

POST/api/performance-audits/{audit}/run

Path parameters

auditintegerRequired

The id of an audit. Digits only. At least 1.

Returns

202 The run is queued. Poll the operation until it finishes.

Fields of the 202 answer
company_idinteger or nullRequired

At least 1.

created_atstring or nullRequired

Format: date-time.

domainsarray of objectsRequired
Fields of each item
environmentstringRequired
http_authbooleanRequired

Whether an HTTP authentication username or password is set.

urlstringRequired
idintegerRequired

At least 1.

namestringRequired
number_of_requestsintegerRequired
page_typesarray of objectsRequired
Fields of each item
check_cachebooleanRequired
pathstring or nullRequired
titlestringRequired
reportobjectRequired

The shared report's state. It never holds the link itself or the password.

Fields
frozen_atstring or nullRequired

When the figures the link shows were built. Format: date-time.

legacy_link_livebooleanRequired

Whether a link made before the report existed still shows its response times and statuses.

password_protectedbooleanRequired
revoked_atstring or nullRequired

Format: date-time.

sectionsarray of objectsRequired
Fields of each item
enabledbooleanRequired
keystringRequired
heroat_a_glanceresponse_timesgapimprovementabsolute_timeswaterfallfilmstripfull_tablegoogle_scoresdefinitionsmethodtiming_breakdownsamplesstatus_codesresponse_headersraw_lighthouse_jsonall_metricscta
labelstringRequired
tabstringRequired
simpletechnicalboth
sharedbooleanRequired

Whether the report link works.

shared_atstring or nullRequired

Format: date-time.

usernamestring or nullRequired

The username the link asks for. Null while it is not protected.

runobjectRequired

The last run started through the API or MCP.

Fields
errorstring or nullRequired

Why a failed run failed.

finished_atstring or nullRequired

Format: date-time.

requested_atstring or nullRequired

Format: date-time.

started_atstring or nullRequired

Format: date-time.

statusstring or nullRequired

Null for an audit never run through the API.

queuedrunningcompletedfailednull
server_locationobject or any or nullRequired

Where the runs are made from. Null when the location no longer exists.

updated_atstring or nullRequired

Format: date-time.

user_agentstringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404noneCheck the id. You see only what your account can reach.
409location_goneThe audit's server location no longer exists. Choose another location for the audit.
409nothing_to_runThe audit has no domains or pages to test. Add them to the audit first.
409run_in_progressThe audit is running. Wait for it to finish.
429rate_limitedWait for the seconds in Retry-After.
503temporarily_unavailableThe 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/5210/run \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "company_id": 1204,
  "created_at": "2026-11-01T09:00: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": 5210,
  "name": "Before and after the move",
  "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:35: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"
}
Try it

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.

Was this helpful?
Open in ClaudeOpen in ChatGPT