Skip to main content
PageVitals logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 28
  • Triggers: 0
  • Slug: PAGE_VITALS
  • Version: 20261101_00

Tools

Slug: PAGE_VITALS_ADD_CONFIGURED_PAGESAdd one or more explicitly supplied pages to PageVitals monitoring for a website. This persistent bulk operation can consume monitored-page quota and cause future synthetic tests, so call it only when the user explicitly requests every URL or path and alias. Never discover or scrape pages automatically.

Input Parameters

array
required
Pages to add in one request (1-100). Every item must contain an explicit URL or path and alias; do not use this field to discover or scrape pages.
string
required
Exact website ID that will own the configured pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_CREATE_BUDGETCreate a persistent PageVitals performance budget for a website. This changes monitoring and may change owner alerting behavior, so call only when the user explicitly requests the budget and supplies the complete metric, comparison direction, numeric threshold in the metric’s native unit, and device scope. Never infer metric units or operator direction.

Input Parameters

number
required
Numeric threshold in the selected metric’s native unit.
string ("desktop" | "mobile" | "all")
required
Device scope to which the performance budget applies.
string
required
Provider-supported PageVitals metric key to constrain, such as ‘lcp’. Do not infer the metric or its unit.
string ("lt" | "gt")
required
Comparison direction: ‘lt’ requires the metric to remain below value; ‘gt’ requires it to remain above value. Do not infer the direction.
string
required
Exact website ID that will own the performance budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_CREATE_MULTISTEP_TESTCreate an empty PageVitals multistep test definition with an explicit name and device profile. This only saves persistent configuration: it does not run the test, trigger any synthetic checks, or consume test-run quota.

Input Parameters

string
required
Human-readable name for the multistep test in the PageVitals admin UI.
string ("desktop" | "mobile")
required
Device profile for the multistep test.
string
required
Exact website ID that will own the multistep test definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_CREATE_WEBSITEAdd a domain to the PageVitals account and begin managing it. This may consume website quota and start monitoring, so call only when the user explicitly asks to add the domain.

Input Parameters

string
required
Bare domain to add, without a protocol or path. Do not infer this value from unrelated text.
string
Optional account-facing name. PageVitals defaults it to the domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_DELETE_BUDGETDelete one PageVitals performance budget and stop enforcing its threshold. This is a destructive alerting mutation; use only when the user explicitly selects the exact budget ID for deletion.

Input Parameters

string
required
Exact budget ID returned by List Budgets. Do not use a metric or name.
string
required
Exact website ID owning the budget.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_DELETE_CONFIGURED_PAGEPermanently delete one PageVitals configured page and all of its test results, including historical results. This is irreversible; use only for an explicit request naming the exact website ID and configured-page ID.

Input Parameters

string
required
Exact configured-page ID returned by List Configured Pages. Do not use a URL, alias, or any other identifier.
string
required
Exact website ID that owns the configured page, as returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_DELETE_MULTISTEP_TESTPermanently delete one PageVitals multistep test definition. This is irreversible; use only when the user explicitly identifies the exact website ID and test ID.

Input Parameters

string
required
Exact opaque multistep test ID to permanently delete. Do not use a test alias or any other identifier.
string
required
Exact opaque website ID that owns the multistep test. Do not use a domain, URL, alias, or display name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_DELETE_WEBSITEPermanently delete one PageVitals website and all of its tests, metrics, analytics, and configuration. This is irreversible; use only for an explicit request naming the exact website ID.

Input Parameters

string
required
Exact opaque website ID returned by List Websites. Never use a domain or display name. Deletion permanently removes the website and all of its tests, metrics, analytics, and configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_MULTISTEP_TESTGet one multistep test definition, including its configured steps.

Input Parameters

string
required
Multistep test ID returned by List or Create Multistep Test.
string
required
Website ID owning the multistep test definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_PAGE_METRICSGet the latest Lighthouse and, when available, Chrome UX Report metrics for one configured page on a desktop or mobile device.

Input Parameters

string ("desktop" | "mobile")
required
Device variant to retrieve. PageVitals requires either desktop or mobile.
string
required
Page ID returned by List Page Metrics.
string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_PAGE_OPPORTUNITIESList Lighthouse improvement opportunities for a page/device, or return the full variable-shape details for one opportunity ID.

Input Parameters

string ("desktop" | "mobile")
required
Device variant to inspect.
string
required
Page ID returned by List Page Metrics.
string
required
Website ID returned by List Websites.
string
Optional ID from this tool’s list response. Omit it to list opportunities; provide it to return that opportunity’s full details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_PAGE_TIMELINEGet one historical timeline for a page/device: combined loading metrics, CrUX, network bytes, CPU time, or Google Search performance. Google Search requires that integration on the website.

Input Parameters

string ("desktop" | "mobile")
required
Device variant whose history to return.
string
required
Page ID returned by List Page Metrics.
string
Optional inclusive range in yyyyMMdd-yyyyMMdd form. Omit it to use the provider default of about 90 days.
string
required
Website ID returned by List Websites.
string ("loading" | "crux" | "network" | "cpu" | "google_search")
required
Report family: loading performance, real-user CrUX, transferred bytes, CPU task time, or Google Search Console metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_TESTGet the detailed Lighthouse, timing, resource, budget, and validation summary for one synthetic test. Provider values, nulls, metric scales, and JSON-looking strings are returned unchanged.

Input Parameters

string
required
Test ID returned by Get Test Series.
string
required
Website ID owning the test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_TEST_REPORTGet one specialized synthetic-test report: keyed Lighthouse opportunities, the request waterfall, or grouped HTML validation findings. Validation always omits the embedded raw HTML.

Input Parameters

string
required
Test ID returned by Get Test Series.
string
required
Website ID owning the test.
string ("opportunities" | "waterfall" | "validation")
required
Specialized diagnostic report to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_GET_TEST_SERIESGet one synthetic test series and its individual tests, statuses, page IDs, device variants, and failure messages.

Input Parameters

string
required
Series ID returned by List Test Series or Run Test Series.
string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_BUDGETSList performance budgets, current status, notification settings, and affected pages for a website.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_CONFIGURED_PAGESList the raw pages configured for PageVitals monitoring on a website.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_MULTISTEP_RUNSList historical runs for one multistep test, including status, duration, interaction, layout-shift, CPU, transfer-size, and blocking-time metrics.

Input Parameters

string
required
Multistep test ID whose historical runs should be listed.
string
required
Website ID owning the multistep test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_MULTISTEP_TESTSList multistep tests configured for a website with recent metrics, state, and success rates. A website with no configured multistep tests returns an empty tests list.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_PAGE_METRICSList every configured page/device combination for a website with recent timeline and latest performance metrics.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_TEST_SERIESList recent synthetic test series for a website, including status and failure counts.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_WEBSITE_OPPORTUNITIESList Lighthouse improvement opportunities aggregated across a website and the affected pages.

Input Parameters

string
required
Website ID returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_LIST_WEBSITESList websites visible to the connected PageVitals API key. Use the returned website IDs with all website-scoped tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_RUN_MULTISTEP_TESTSTrigger exactly one named multistep test or intentionally fan out to every multistep test configured for a website. Every triggered run consumes PageVitals test quota and may incur cost. Choosing target=‘all’ can start many jobs, so use it only when the user explicitly requests an all-tests run.

Input Parameters

string ("single" | "all")
required
Choose ‘single’ to run exactly one test, or ‘all’ to intentionally fan out and run every multistep test configured for the website. Both modes consume PageVitals test quota; ‘all’ can trigger many jobs.
string
Exact multistep test ID from List Multistep Tests. Required only when target is ‘single’ and forbidden when target is ‘all’.
string
required
Exact website ID whose multistep test or tests should run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_RUN_TEST_SERIESTrigger synthetic tests for selected page/device variants, or for every configured test when pages is omitted. This action consumes PageVitals test quota and may incur cost; call it only when the user explicitly requests a new run.

Input Parameters

array
Exact page/device selections to test. Omit this field only when intentionally running every configured test for the website. Running tests consumes PageVitals test quota and may incur cost.
string
Optional label identifying the process or person that started the run.
string
required
Exact website ID whose synthetic tests should run.
string
Optional reason or deployment description for the test run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_UPDATE_BUDGETReplace a PageVitals performance budget’s complete metric threshold and device scope. This may change monitoring alerts or notifications. Read the current budget first, use its exact website and budget IDs, and provide all four desired state fields because partial PUT behavior was not safely tested.

Input Parameters

string
required
Complete desired numeric threshold in the metric’s native unit.
string ("desktop" | "mobile" | "all")
required
Complete desired device scope for the budget.
string
required
Complete desired PageVitals metric key, such as lcp.
string ("lt" | "gt")
required
Complete desired comparison: lt requires the metric below value; gt requires it above value.
string
required
Exact budget ID to replace, as returned by List Budgets.
string
required
Exact website ID owning the budget, as returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_UPDATE_CONFIGURED_PAGEUpdate a configured PageVitals page’s URL, display alias, or both. This changes persistent monitoring configuration; use the exact page ID from List Configured Pages and provide at least one new value.

Input Parameters

string
New website-relative URL or path. Omit to retain the current URL.
string
New display alias. Omit to retain the current alias.
string
required
Exact configured-page ID returned by List Configured Pages.
string
required
Exact website ID owning the configured page, as returned by List Websites.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAGE_VITALS_UPDATE_MULTISTEP_TESTUpdate a multistep test’s alias and device. Both fields are required because PageVitals PUT replacement and partial-update semantics were not safely live-tested; read the current test first when preserving either value.

Input Parameters

string
required
Complete desired human-readable alias after the update.
string ("desktop" | "mobile")
required
Complete desired device profile after the update.
string
required
Exact multistep test ID to update.
string
required
Website ID owning the multistep test definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not