Get all data for a given strace

GET/projects/{projectId}/straces/{straceId}/

API version

Request method

GET

Operation ID

pageinsights-get-strace-data

Request

straceIdstring (uuid)
required
ID of the strace to get the data for.
projectIdstring (uuid)
required
ID of the project the strace belongs to.

Responses

Format

application/json

Beschreibung

Schema-Dokumentation
Beispiel
JSON Schema

executedAtstring (date-time)
required
idstring (uuid)
required
resultone of 2 alternatives
required
- Alternativeobject
  - errorMessagestring
    required
- Alternativeobject
  - actualUrlstring
    required
  - dbQueriesarray of object
    required
    - Array[
    - *object
      - querystring
        required
        The whole DB query.
      - statsobject
        required
        kernelMsnumber
        required
        Elapsed kernel space time in milliseconds.
        occurrencesinteger
        required
        The number of times this group occurred.
        syscallCountinteger
        required
        Syscall count.
        userspaceMsnumber
        required
        Elapsed user space time in milliseconds.
      - warnLevelstring (one of: NO, WARN, SEVERE)
        required
        Alerts when the time, syscall count or occurrence count of this group are abnormal.
- dbStatsobject
  required
  - kernelMsnumber
    required
    Elapsed kernel space time in milliseconds.
  - occurrencesinteger
    required
    The number of times this group occurred.
  - syscallCountinteger
    required
    Syscall count.
  - userspaceMsnumber
    required
    Elapsed user space time in milliseconds.
- fileOpsarray of object
  required
  - Array[
  - *object
    - filenamestring
    - filepathstring
    - statsobject
      required
      - kernelMsnumber
        required
        Elapsed kernel space time in milliseconds.
      - occurrencesinteger
        required
        The number of times this group occurred.
      - syscallCountinteger
        required
        Syscall count.
      - userspaceMsnumber
        required
        Elapsed user space time in milliseconds.
    - warnLevelstring (one of: NO, WARN, SEVERE)
      required
      Alerts when the time, syscall count or occurrence count of this group are abnormal.
fileOpsStatsobject
required
- kernelMsnumber
  required
  Elapsed kernel space time in milliseconds.
- occurrencesinteger
  required
  The number of times this group occurred.
- syscallCountinteger
  required
  Syscall count.
- userspaceMsnumber
  required
  Elapsed user space time in milliseconds.
miscStatsobject
required
- kernelMsnumber
  required
  Elapsed kernel space time in milliseconds.
- occurrencesinteger
  required
  The number of times this group occurred.
- syscallCountinteger
  required
  Syscall count.
- userspaceMsnumber
  required
  Elapsed user space time in milliseconds.
networkingOpsarray of object
required
- Array[
- *object
  - connectionTypestring (one of: UNKNOWN, PRIVATE, EXTERNAL)
    required
  - descriptionstring
    required
    A short description of the network connection to provide additional context.
  - ipstring
    required
    IP address to which a connection was established.
  - portinteger
    required
    Port to which a connection was established.
  - statsobject
    required
    - kernelMsnumber
      required
      Elapsed kernel space time in milliseconds.
    - occurrencesinteger
      required
      The number of times this group occurred.
    - syscallCountinteger
      required
      Syscall count.
    - userspaceMsnumber
      required
      Elapsed user space time in milliseconds.
  - warnLevelstring (one of: NO, WARN, SEVERE)
    required
    Alerts when the time, syscall count or occurrence count of this group are abnormal.

networkingStatsobject

required

kernelMsnumber
required
Elapsed kernel space time in milliseconds.
occurrencesinteger
required
The number of times this group occurred.
syscallCountinteger
required
Syscall count.
userspaceMsnumber
required
Elapsed user space time in milliseconds.

slowdownFactornumber

required

Shows how much slower the websites TTFB was when it got traced (1.0 = 100% = same TTFB).

ttfbMsinteger

required

Time to first byte in milliseconds while tracing the website.

{
  "executedAt": "2025-01-18T00:31:04.387Z",
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "result": {
    "errorMessage": "wrong PHP version"
  }
}

{
  "properties": {
    "executedAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "result": {
      "oneOf": [
        {
          "properties": {
            "errorMessage": {
              "example": "wrong PHP version",
              "type": "string"
            }
          },
          "required": [
            "errorMessage"
          ],
          "type": "object"
        },
        {
          "properties": {
            "actualUrl": {
              "example": "https://www.mittwald.de/~b",
              "type": "string"
            },
            "dbQueries": {
              "items": {
                "properties": {
                  "query": {
                    "description": "The whole DB query.",
                    "example": "SELECT * FROM my_table;",
                    "type": "string"
                  },
                  "stats": {
                    "properties": {
                      "kernelMs": {
                        "description": "Elapsed kernel space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      },
                      "occurrences": {
                        "description": "The number of times this group occurred.",
                        "example": 25,
                        "type": "integer"
                      },
                      "syscallCount": {
                        "description": "Syscall count.",
                        "example": 4321,
                        "type": "integer"
                      },
                      "userspaceMs": {
                        "description": "Elapsed user space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      }
                    },
                    "required": [
                      "kernelMs",
                      "userspaceMs",
                      "syscallCount",
                      "occurrences"
                    ],
                    "type": "object"
                  },
                  "warnLevel": {
                    "description": "Alerts when the time, syscall count or occurrence count of this group are abnormal.",
                    "enum": [
                      "NO",
                      "WARN",
                      "SEVERE"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "query",
                  "stats",
                  "warnLevel"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "dbStats": {
              "properties": {
                "kernelMs": {
                  "description": "Elapsed kernel space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                },
                "occurrences": {
                  "description": "The number of times this group occurred.",
                  "example": 25,
                  "type": "integer"
                },
                "syscallCount": {
                  "description": "Syscall count.",
                  "example": 4321,
                  "type": "integer"
                },
                "userspaceMs": {
                  "description": "Elapsed user space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                }
              },
              "required": [
                "kernelMs",
                "userspaceMs",
                "syscallCount",
                "occurrences"
              ],
              "type": "object"
            },
            "fileOps": {
              "items": {
                "properties": {
                  "filename": {
                    "example": "my_file.php",
                    "type": "string"
                  },
                  "filepath": {
                    "example": "/html/my-project",
                    "type": "string"
                  },
                  "stats": {
                    "properties": {
                      "kernelMs": {
                        "description": "Elapsed kernel space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      },
                      "occurrences": {
                        "description": "The number of times this group occurred.",
                        "example": 25,
                        "type": "integer"
                      },
                      "syscallCount": {
                        "description": "Syscall count.",
                        "example": 4321,
                        "type": "integer"
                      },
                      "userspaceMs": {
                        "description": "Elapsed user space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      }
                    },
                    "required": [
                      "kernelMs",
                      "userspaceMs",
                      "syscallCount",
                      "occurrences"
                    ],
                    "type": "object"
                  },
                  "warnLevel": {
                    "description": "Alerts when the time, syscall count or occurrence count of this group are abnormal.",
                    "enum": [
                      "NO",
                      "WARN",
                      "SEVERE"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "stats",
                  "warnLevel"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "fileOpsStats": {
              "properties": {
                "kernelMs": {
                  "description": "Elapsed kernel space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                },
                "occurrences": {
                  "description": "The number of times this group occurred.",
                  "example": 25,
                  "type": "integer"
                },
                "syscallCount": {
                  "description": "Syscall count.",
                  "example": 4321,
                  "type": "integer"
                },
                "userspaceMs": {
                  "description": "Elapsed user space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                }
              },
              "required": [
                "kernelMs",
                "userspaceMs",
                "syscallCount",
                "occurrences"
              ],
              "type": "object"
            },
            "miscStats": {
              "properties": {
                "kernelMs": {
                  "description": "Elapsed kernel space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                },
                "occurrences": {
                  "description": "The number of times this group occurred.",
                  "example": 25,
                  "type": "integer"
                },
                "syscallCount": {
                  "description": "Syscall count.",
                  "example": 4321,
                  "type": "integer"
                },
                "userspaceMs": {
                  "description": "Elapsed user space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                }
              },
              "required": [
                "kernelMs",
                "userspaceMs",
                "syscallCount",
                "occurrences"
              ],
              "type": "object"
            },
            "networkingOps": {
              "items": {
                "properties": {
                  "connectionType": {
                    "enum": [
                      "UNKNOWN",
                      "PRIVATE",
                      "EXTERNAL"
                    ],
                    "type": "string"
                  },
                  "description": {
                    "description": "A short description of the network connection to provide additional context.",
                    "type": "string"
                  },
                  "ip": {
                    "description": "IP address to which a connection was established.",
                    "type": "string"
                  },
                  "port": {
                    "description": "Port to which a connection was established.",
                    "type": "integer"
                  },
                  "stats": {
                    "properties": {
                      "kernelMs": {
                        "description": "Elapsed kernel space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      },
                      "occurrences": {
                        "description": "The number of times this group occurred.",
                        "example": 25,
                        "type": "integer"
                      },
                      "syscallCount": {
                        "description": "Syscall count.",
                        "example": 4321,
                        "type": "integer"
                      },
                      "userspaceMs": {
                        "description": "Elapsed user space time in milliseconds.",
                        "example": 1.2345,
                        "type": "number"
                      }
                    },
                    "required": [
                      "kernelMs",
                      "userspaceMs",
                      "syscallCount",
                      "occurrences"
                    ],
                    "type": "object"
                  },
                  "warnLevel": {
                    "description": "Alerts when the time, syscall count or occurrence count of this group are abnormal.",
                    "enum": [
                      "NO",
                      "WARN",
                      "SEVERE"
                    ],
                    "type": "string"
                  }
                },
                "required": [
                  "ip",
                  "port",
                  "description",
                  "connectionType",
                  "stats",
                  "warnLevel"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "networkingStats": {
              "properties": {
                "kernelMs": {
                  "description": "Elapsed kernel space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                },
                "occurrences": {
                  "description": "The number of times this group occurred.",
                  "example": 25,
                  "type": "integer"
                },
                "syscallCount": {
                  "description": "Syscall count.",
                  "example": 4321,
                  "type": "integer"
                },
                "userspaceMs": {
                  "description": "Elapsed user space time in milliseconds.",
                  "example": 1.2345,
                  "type": "number"
                }
              },
              "required": [
                "kernelMs",
                "userspaceMs",
                "syscallCount",
                "occurrences"
              ],
              "type": "object"
            },
            "slowdownFactor": {
              "description": "Shows how much slower the websites TTFB was when it got traced (1.0 = 100% = same TTFB).",
              "example": 1.5,
              "type": "number"
            },
            "ttfbMs": {
              "description": "Time to first byte in milliseconds while tracing the website.",
              "example": 1532,
              "type": "integer"
            }
          },
          "required": [
            "actualUrl",
            "ttfbMs",
            "slowdownFactor",
            "fileOpsStats",
            "networkingStats",
            "dbStats",
            "miscStats",
            "fileOps",
            "networkingOps",
            "dbQueries"
          ],
          "type": "object"
        }
      ]
    }
  },
  "required": [
    "id",
    "executedAt",
    "result"
  ],
  "type": "object"
}

Usage examples

cURL
JavaScript SDK
PHP SDK

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/straces/f0f86186-0a5a-45b2-aa33-502777496347

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.pageinsightsGetStraceData({
  "straceId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

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

$request = (new GetStraceDataRequest(
  straceId: "f0f86186-0a5a-45b2-aa33-502777496347",
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->pageInsights()->getStraceData($request);

var_dump($response->getBody();
  

Request​

Pfad-Parameter required

Responses​

200 OK

400 Bad Request

403 Forbidden

429 Too Many Requests

default

Usage examples​

Request

Responses

Usage examples