Get detailed performance data for a given domain and path

GET/page-insights/

API version

v2

Request method

GET

Operation ID

pageinsights-get-performance-data

---

Request

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• createdAtstring (date-time)
• domainstring

  required
• metricsarray of object
  • Array[
  • *object
    • createdAtstring (date-time)

      required
    • namestring

      required
    • scorenumber (double)
    • valuenumber (double)

      required
  ]

moreDataAvailablearray of string (date)

• Array[
• *string (date)
]

pathstring

required

performanceScorenumber (double)

required

screenshotobject

• createdAtstring (date-time)

  required
• fileRefstring

  required

Beispiel

{
  "createdAt": "2024-12-18T07:57:21.290Z",
  "domain": "string",
  "metrics": [
    {
      "createdAt": "2024-12-18T07:57:21.290Z",
      "name": "string",
      "score": 123,
      "value": 123
    }
  ],
  "moreDataAvailable": [
    "string"
  ],
  "path": "string",
  "performanceScore": 123,
  "screenshot": {
    "createdAt": "2024-12-18T07:57:21.290Z",
    "fileRef": "string"
  }
}

JSON Schema

{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "metrics": {
      "items": {
        "properties": {
          "createdAt": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "score": {
            "format": "double",
            "nullable": true,
            "type": "number"
          },
          "value": {
            "format": "double",
            "type": "number"
          }
        },
        "required": [
          "name",
          "value",
          "createdAt"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "moreDataAvailable": {
      "items": {
        "format": "date",
        "type": "string"
      },
      "type": "array"
    },
    "path": {
      "type": "string"
    },
    "performanceScore": {
      "format": "double",
      "type": "number"
    },
    "screenshot": {
      "properties": {
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "fileRef": {
          "type": "string"
        }
      },
      "required": [
        "fileRef",
        "createdAt"
      ],
      "type": "object"
    }
  },
  "required": [
    "domain",
    "path",
    "performanceScore"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/page-insights?domain=string&path=string&date=string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.pageInsights.pageinsightsGetPerformanceData({
  "queryParameters": {
    "domain": "string",
    "path": "string",
    "date": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\PageInsights\GetPerformanceData\GetPerformanceDataRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetPerformanceDataRequest())
  ->withDomain("string")
  ->withPath("string")
  ->withDate("string");
$response = $client->pageInsights()->getPerformanceData($request);

var_dump($response->getBody();