---
title: "Start a performance audit run"
url: https://docs.corefinity.com/api/reference/logs/start-performance-audit-run
type: endpoint
last_updated: 2026-11-13
feature: performance-audits
related:
  - https://docs.corefinity.com/guides/tools/performance-audits.md
---
# 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`.

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

- Scope: `write`
- Rate limit: 10 a minute
- Long-running: answers with an operation to poll
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `audit` (integer, required): The id of an audit. Digits only.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/performance-audits/5210/run \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/performance-audits/5210/run');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/performance-audits/5210/run', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.post(
    "https://manage.corefinity.com/api/performance-audits/5210/run",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 202 The run is queued.

```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"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the `write` scope (`scope_required`).

```json
{
  "code": "scope_required",
  "message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
  "reason": "scope_required",
  "scope": "destructive"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 409 A run is already queued or running (`run_in_progress`), the audit has no environments or pages (`nothing_to_run`), or its server location no longer exists (`location_gone`).

```json
{
  "code": "location_gone",
  "message": "This audit's server location no longer exists. Choose another server location for the audit first.",
  "reason": "location_gone"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

### 503 Audits cannot run right now (`temporarily_unavailable`). Nothing was queued.

```json
{
  "code": "temporarily_unavailable",
  "message": "Performance audits cannot run right now. Try again later.",
  "reason": "temporarily_unavailable"
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 |  | Check the id. You see only what your account can reach. |
| 409 | `location_gone` | The audit's server location no longer exists. Choose another location for the audit. |
| 409 | `nothing_to_run` | The audit has no domains or pages to test. Add them to the audit first. |
| 409 | `run_in_progress` | The audit is running. Wait for it to finish. |
| 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. |

## The same task elsewhere

- Guide: [Performance audits](https://docs.corefinity.com/guides/tools/performance-audits.md)
