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

Get a performance audit

Answers the audit with its results, one cell for each environment, page and cache state, and its request log. This is also how a run is followed: run.status is queued, running, completed or failed, and a run that has not finished in time is ended as failed.

GET/api/performance-audits/{audit}

Path parameters

auditintegerRequired

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

Returns

200 The audit.

Fields of the 200 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
logstringRequired

The runs' request log.

resultsarray of objectsRequired
Fields of each item
activebooleanRequired
cachestringRequired
uncachedcached
environmentstringRequired
errorstring or nullRequired
http_codeinteger or nullRequired

The HTTP status of the page. 0 when there was no HTTP answer.

ipv4_requestsinteger or nullRequired
ipv6_requestsinteger or nullRequired
mean_ttfb_msnumber or nullRequired

The mean time to first byte, connection included. Null when the cell has not run.

pagestringRequired
pathstring or nullRequired
ranbooleanRequired
server_response_msnumber or nullRequired

The mean time the server took to answer: time to first byte less DNS, connect and TLS.

timing_msobject or any or nullRequired

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.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/performance-audits/5210 \
  -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,
  "log": "URL: https://old.harbourandfinch.example.org/ - Response code: 200 - TTFB: 612.40 ms - Total: 638.95 ms - Size: 48210 bytes - DNS 1.0 / connect 20.0 / TLS 60.0 ms - 192.0.2.1\n",
  "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
  },
  "results": [
    {
      "active": true,
      "cache": "uncached",
      "environment": "Current host",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 612.4,
      "page": "Home",
      "path": "/",
      "ran": true,
      "server_response_ms": 552.4,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 638.95,
        "transfer": 26.55,
        "ttfb": 552.4
      }
    },
    {
      "active": true,
      "cache": "cached",
      "environment": "Current host",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 188.2,
      "page": "Home",
      "path": "/",
      "ran": true,
      "server_response_ms": 128.2,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 214.75,
        "transfer": 26.55,
        "ttfb": 128.2
      }
    },
    {
      "active": true,
      "cache": "uncached",
      "environment": "Current host",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 704.9,
      "page": "Category",
      "path": "/shop/",
      "ran": true,
      "server_response_ms": 644.9,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 731.45,
        "transfer": 26.55,
        "ttfb": 644.9
      }
    },
    {
      "active": false,
      "cache": "cached",
      "environment": "Current host",
      "error": null,
      "http_code": null,
      "ipv4_requests": null,
      "ipv6_requests": null,
      "mean_ttfb_ms": null,
      "page": "Category",
      "path": "/shop/",
      "ran": false,
      "server_response_ms": null,
      "timing_ms": null
    },
    {
      "active": true,
      "cache": "uncached",
      "environment": "Corefinity",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 241.3,
      "page": "Home",
      "path": "/",
      "ran": true,
      "server_response_ms": 181.3,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 267.85,
        "transfer": 26.55,
        "ttfb": 181.3
      }
    },
    {
      "active": true,
      "cache": "cached",
      "environment": "Corefinity",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 63.5,
      "page": "Home",
      "path": "/",
      "ran": true,
      "server_response_ms": 3.5,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 90.05,
        "transfer": 26.55,
        "ttfb": 3.5
      }
    },
    {
      "active": true,
      "cache": "uncached",
      "environment": "Corefinity",
      "error": null,
      "http_code": 200,
      "ipv4_requests": 5,
      "ipv6_requests": 0,
      "mean_ttfb_ms": 286.75,
      "page": "Category",
      "path": "/shop/",
      "ran": true,
      "server_response_ms": 226.75,
      "timing_ms": {
        "dns": 1,
        "tcp": 19,
        "tls": 40,
        "total": 313.3,
        "transfer": 26.55,
        "ttfb": 226.75
      }
    },
    {
      "active": false,
      "cache": "cached",
      "environment": "Corefinity",
      "error": null,
      "http_code": null,
      "ipv4_requests": null,
      "ipv6_requests": null,
      "mean_ttfb_ms": null,
      "page": "Category",
      "path": "/shop/",
      "ran": false,
      "server_response_ms": null,
      "timing_ms": null
    }
  ],
  "run": {
    "error": null,
    "finished_at": "2026-11-03T12:35:00+00:00",
    "requested_at": "2026-11-03T12:30:00+00:00",
    "started_at": "2026-11-03T12:30:00+00:00",
    "status": "completed"
  },
  "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
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT