Web API Reference

Web

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET

Retrieve web vitals

Get web vitals for a specific pathname. Toolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators).

Required API key scopes

query:read

Path parameters

project_id
string

Query parameters

pathname
string

Example request

GET /api/environments/:project_id/web_vitals
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/web_vitals/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/web_vitals/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Web

Endpoints

Retrieve web vitals

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Community questions