> ## Documentation Index
> Fetch the complete documentation index at: https://docs.landerlab.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Engagement web vitals

> Core Web Vitals per device class: p75 of LCP, INP, FCP, TTFB (ms) and CLS, with good / needs improvement / poor sample counts. Requires the Engagement add-on.



## OpenAPI

````yaml https://backend-v2.landerlab.workers.dev/api/v2/openapi.json get /api/v2/workspaces/{workspaceId}/landers/{landerId}/engagement/vitals
openapi: 3.1.0
info:
  title: LanderLab API
  version: 2.0.0
  description: >-
    LanderLab public API. Authenticate with an API key using the X-API-Key
    header.
servers:
  - url: https://api.landerlab.dev
    description: Production
security: []
tags:
  - name: Account
    description: >-
      Discover the organization and workspaces your API key can access. Start
      here.
  - name: Workspaces
    description: List and manage workspaces.
  - name: Landers
    description: Create, update, publish and manage landers.
  - name: A/B Testing
    description: Manage variants and split-test weights.
  - name: Editor
    description: Load and save lander content and settings.
  - name: Analytics
    description: Query unified analytics across workspaces, landers and variants.
  - name: Engagement
    description: >-
      Per-lander engagement reports: engagement rate, scroll depth, attention,
      clicks, web vitals, JS errors and live visitors.
  - name: Leads
    description: Retrieve captured leads.
  - name: Integrations
    description: Manage account-level integrations.
  - name: Lander Integrations
    description: Attach and toggle integrations on landers.
  - name: Domains
    description: Manage custom domains.
  - name: Folders
    description: Organize landers into folders.
paths:
  /api/v2/workspaces/{workspaceId}/landers/{landerId}/engagement/vitals:
    get:
      tags:
        - Engagement
      summary: Engagement web vitals
      description: >-
        Core Web Vitals per device class: p75 of LCP, INP, FCP, TTFB (ms) and
        CLS, with good / needs improvement / poor sample counts. Requires the
        Engagement add-on.
      parameters:
        - name: landerId
          in: path
          required: true
          schema:
            type: integer
        - name: startDate
          in: query
          required: true
          schema:
            type: string
          description: YYYY-MM-DD, inclusive, in `timezone`
        - name: endDate
          in: query
          required: true
          schema:
            type: string
          description: YYYY-MM-DD, inclusive, in `timezone`
        - name: timezone
          in: query
          schema:
            type: string
          description: IANA timezone (default UTC)
        - name: variantIds
          in: query
          schema:
            type: string
          description: 'Comma-separated variant ids (default: all variants of the lander)'
        - name: device
          in: query
          schema:
            type: string
            enum:
              - desktop
              - tablet
              - mobile
        - name: country
          in: query
          schema:
            type: string
          description: ISO 3166-1 alpha-2 country code, upper case
        - name: channel
          in: query
          schema:
            type: string
            enum:
              - direct
              - internal
              - organic_search
              - paid_search
              - organic_social
              - paid_social
              - email
              - display
              - affiliate
              - referral
      responses:
        '200':
          description: Engagement web vitals
          content:
            application/json:
              schema:
                type: object
                propertyNames:
                  type: string
                additionalProperties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with ll_live_ prefix

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.