google_api_page_speed_online v0.5.0 GoogleApi.PageSpeedOnline.V4.Api.Pagespeedapi View Source

API calls for all endpoints tagged Pagespeedapi.

Link to this section Summary

Functions

Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.

Link to this section Functions

Link to this function

pagespeedonline_pagespeedapi_runpagespeed(connection, url, optional_params \\ [], opts \\ [])

View Source
pagespeedonline_pagespeedapi_runpagespeed(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4.t()}
  | {:error, Tesla.Env.t()}

Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.

Parameters

  • connection (type: GoogleApi.PageSpeedOnline.V4.Connection.t) - Connection to server
  • url (type: String.t) - The URL to fetch and analyze
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :filter_third_party_resources (type: boolean()) - Indicates if third party resources should be filtered out before PageSpeed analysis.
    • :locale (type: String.t) - The locale used to localize formatted results
    • :rule (type: list(String.t)) - A PageSpeed rule to run; if none are given, all rules are run
    • :screenshot (type: boolean()) - Indicates if binary data containing a screenshot should be included
    • :snapshots (type: boolean()) - Indicates if binary data containing snapshot images should be included
    • :strategy (type: String.t) - The analysis strategy (desktop or mobile) to use, and desktop is the default
    • :utm_campaign (type: String.t) - Campaign name for analytics.
    • :utm_source (type: String.t) - Campaign source for analytics.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.PageSpeedOnline.V4.Model.PagespeedApiPagespeedResponseV4{}} on success
  • {:error, info} on failure