Observations API

The observations API provides metadata of monitoring, configuration or code-level bottlenecks and problems.

Requirements: You need an API access token with the issues scope for this endpoint.

You can access data for your project through the URL scheme.

https://app.tideways.io/apps/api/{organization}/{app}/observations

Example:

curl -H 'Authorization: Bearer <token>' \
     -X GET \
     https://app.tideways.io/apps/api/demos-tideways/Shopware6/observations

Response:

{
    "observations": [
        {
            "type": "opcache_low_interned_strings",
            "source": "configuration",
            "label": "OPcache is running low on interned strings memory",
            "status": "error",
            "doc_link": "https://support.tideways.com/documentation/reference/observations/opcache-low-interned-strings.html",
            "app_link": "https://app.tideways.io/o/demos-tideways/Shopware6/issues/observation?error=opcache_low_interned_strings&s=web&env=production",
            "origins": [
                "dbef7aa24b37"
            ]
        },
        {
            "type": "bottleneck-php/token_get_all",
            "source": "traces",
            "label": "Use of token_get_all in web context should be cached.",
            "status": "warning",
            "app_link": "https://app.tideways.io/o/demos-tideways/Shopware6/issues/observation?error=bottleneck-php/token_get_all&s=web&env=production"
        },
        {
            "type": "default_socket_timeout",
            "source": "configuration",
            "label": "Socket Timeout at 60 seconds default or higher",
            "status": "warning",
            "doc_link": "https://support.tideways.com/documentation/reference/observations/default-socket-timeout.html",
            "app_link": "https://app.tideways.io/o/demos-tideways/Shopware6/issues/observation?error=default_socket_timeout&s=web&env=production",
            "origins": [
                "dbef7aa24b37"
            ]
        }
    ],
    "criteria": {
        "organization": "demos-tideways",
        "application": "Shopware6",
        "environment": "production",
        "service": "web",
        "status": "open"
    }
}

Parameters

You can pass a number of query parameters to this API endpoint:

  • env represents the name of an environment, for example the default production

  • s represents the name of a service, for example the default web.

Still need help? Email [email protected]