Schedule a strace measurement for a single http request

POST /v2/projects/{projectId}/straces/

API version

v2

Request method

POST

Operation ID

pageinsights-schedule-strace

---

Request

• projectIdstring (uuid)

  required

  ID of a project to own the created strace. It must exist a ingress with the same hostname as in the url to be measured.

Responses

Format

application/json

Beschreibung

Scheduled

Schema-Dokumentation

• idstring (uuid)

  required

Beispiel

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"url":"https://example.com"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/projects/f0f86186-0a5a-45b2-aa33-502777496347/straces

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.pageinsightsScheduleStrace({
  "projectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "url": "https://example.com"
  }
});

assertStatus(response, 202);
  

PHP SDK

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

// TODO: Please consult the properties and constructor signature of
// ScheduleStraceRequestBody to learn how to construct a valid instance
$body = new ScheduleStraceRequestBody(/* TODO: ... */);

$request = (new ScheduleStraceRequest(
  projectId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->pageInsights()->scheduleStrace($request);

var_dump($response->getBody();