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

List an audit's GTmetrix reports

Answers the audit's GTmetrix reports, environment by page, each read from GTmetrix as you ask; generation is the last request to generate reports, which is how one is followed. Paged by cursor: send next_cursor back as cursor; null means the last page.

GET/api/performance-audits/{audit}/gtmetrix-reports

Path parameters

auditintegerRequired

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

Query parameters

limitinteger

Items a page: 1 to 10, default 5.

cursorstring

The next_cursor of the previous answer. Anything that is not a whole number is refused 422 on cursor.

framesstring

1 adds each filmstrip image to a completed report, as a base64 JPEG. Only 0 and 1 are taken: the words true and false are refused 422 on frames. Defaults to 0.

01

Returns

200 One page of reports.

Fields of the 200 answer
next_cursorstring or nullRequired

Send as cursor to read the next page. Null on the last page.

generationobject or any or nullRequired

The last generation requested through the API or MCP. Null when none was.

itemsarray of objectsRequired
Fields of each item
errorstring or nullRequired
filmstrip_timings_msarray of numbersRequired
framesarray of objects

With frames=1: each filmstrip image.

Fields of each item
jpeg_base64stringRequired
timing_msnumberRequired
metricsobject or any or nullRequired

The figures of a completed test.

namestringRequired

The environment and the page, such as Corefinity Home.

statestring or nullRequired

GTmetrix's own state of the test.

statusstringRequired

pending: GTmetrix is still testing. gone: GTmetrix no longer has the test. not_started: no test was started for it. unavailable: GTmetrix did not answer for it this time.

completedpendingfailedgonenot_startedunavailable
test_idstring 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.
422invalidFix the field named in field; errors says why.
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 https://manage.corefinity.com/api/performance-audits/5210/gtmetrix-reports \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "generation": null,
  "items": [
    {
      "error": null,
      "filmstrip_timings_ms": [
        0,
        500
      ],
      "metrics": {
        "cumulative_layout_shift": 0.12345,
        "dom_content_loaded_time_ms": 900,
        "first_contentful_paint_ms": 800,
        "first_paint_time_ms": 700,
        "fully_loaded_time_ms": 2500,
        "gtmetrix_grade": "B",
        "largest_contentful_paint_ms": 1300,
        "performance_score": 88,
        "speed_index_ms": 1100,
        "structure_score": 91,
        "time_to_first_byte_ms": 100,
        "time_to_interactive_ms": 1500,
        "total_blocking_time_ms": 50
      },
      "name": "Current host Home",
      "state": "completed",
      "status": "completed",
      "test_id": "Abc12Def"
    },
    {
      "error": null,
      "filmstrip_timings_ms": [],
      "metrics": null,
      "name": "Current host Category",
      "state": "started",
      "status": "pending",
      "test_id": "Ghi34Jkl"
    },
    {
      "error": null,
      "filmstrip_timings_ms": [],
      "metrics": null,
      "name": "Corefinity Home",
      "state": null,
      "status": "not_started",
      "test_id": null
    },
    {
      "error": "The page could not be loaded.",
      "filmstrip_timings_ms": [],
      "metrics": null,
      "name": "Corefinity Category",
      "state": "error",
      "status": "failed",
      "test_id": "Mno56Pqr"
    }
  ],
  "next_cursor": null
}
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