Settings API - Key performance metrics schema table

    Key performance metrics (builtin:synthetic.browser.kpms)

    Select the key performance metric that best represents the user experience of this synthetic monitor.

    Visually complete is the default metric for load and XHR actions. It measures how long it takes for the visible portion of each user’s browser screen to be fully rendered.

    The key performance metric for custom actions is always User action duration.

    Schema IDSchema groupsScope
    builtin:synthetic.browser.kpms
    • group:synthetic.browser
    SYNTHETIC_TEST - Synthetic monitor
    GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.kpms
    SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.browser.kpms
    Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.browser.kpms

    Authentication

    To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

    Parameters

    PropertyTypeDescriptionRequired
    Load action key performance metric
    loadActionKpm    		enum
    • USER_ACTION_DURATION
    • VISUALLY_COMPLETE
    • SPEED_INDEX
    • DOM_INTERACTIVE
    • LOAD_EVENT_START
    • LOAD_EVENT_END
    • RESPONSE_START
    • RESPONSE_END
    • LARGEST_CONTENTFUL_PAINT
    • CUMULATIVE_LAYOUT_SHIFT
    		required
    XHR action key performance metric
    xhrActionKpm    		enum
    • USER_ACTION_DURATION
    • VISUALLY_COMPLETE
    • RESPONSE_START
    • RESPONSE_END
    		required