Responses

• 201

  A lighthouse report to be returned

  Hide response attributes Show response attributes object

  • id string
  • url string Required
  • device string Required

    Values are mobile, desktop, macbookAirM1, highEndLaptop, ipad102, galaxyTabS7, iphone13ProMax, iphone11, galaxyS10Plus, redmiNote8Pro, iphone7, galaxyA50, galaxyJ8, motoG5, or redmi5A.

  • location string Required

    Values are us, ca, br, de, uk, nl, pl, ch, jp, in, sg, au, id, kr, or tw.

  • config object
    Hide config attributes Show config attributes object

    • connection string | null

      Connection Type

      Maximum length is 5000. Values are fiber, cable, dsl, 5g, wifi_fast, wifi, 4g_fast, 4g, 3g_fast, 3g, 3g_slow, 2g_edge, or 2g.

    • throttling_method string | null

      Choose between simulated throttling and applied throttling

      Maximum length is 5000. Default value is simulated.

    • http_version string | null

      Force HTTP/1.1 or HTTP/2(default)

      Maximum length is 5000. Default value is 2.

    • video boolean | null

      Enable page load video

      Maximum length is 5000. Default value is false.

    • adblock boolean | null

      Enable Adblock

      Default value is false.

    • user_agent string | null

      Run test with custom user agent

      Maximum length is 5000.

    • auth_username string | null

      Username for authentication

      Maximum length is 5000.

    • auth_password string | null

      Password for authentication

      Maximum length is 5000.

    • cookies array[string] | null

      List of session cookies

    • whitelist array[string] | null

      List of whitelisted urls(Max 5)

    • blacklist array[string] | null

      List of blacklisted urls(Max 10)

  • status string Required

    Values are idle, active, success, or failed.

  • lighthouse_version string Required

    The version of the lighthouse used to generate the report

  • metrics object | null
    Hide metrics attributes Show metrics attributes object | null

    • cumulative_layout_shift number

      Cumulative Layout Shift

    • first_contentful_paint number

      First Contentful Paint time (in milliseconds)

    • first_meaningful_paint number

      First Meaningful Paint time (in milliseconds)

    • time_to_interactive number

      Time to Interactive (in milliseconds)

    • largest_contentful_paint number

      Largest Contentful Paint time (in milliseconds)

    • server_response_time number

      TTFB (in milliseconds)

    • speed_index number

      Speed Index (in milliseconds)

    • total_blocking_time number

      Total Blocking time (in milliseconds)

    • performance_score number

      Performance Score (in percentage)

  • report_url string | null

    The URL at which SpeedVitals report is accessible (Present when status is success)

  • created_at number

    Time at which the test was created. Measured in seconds since the Unix epoch.

  • expires_at number

    Time at which the report will expire. Measured in seconds since the Unix epoch.

  • error object | null

    Contains error code and description(present only if status is failed)

    Hide error attributes Show error attributes object | null

    • code string

      Error code specific to lighthouse error

    • message string

      Error message describing the summary of lighthouse error

• 400

  Invalid Request body or missing required parameters

  Hide response attributes Show response attributes object

  • code string

    An error code specific to the error.

  • message string

    A human-readable message providing more details about the error.

• 402

  Insufficient Credits

  Hide response attributes Show response attributes object

  • code string

    An error code specific to the error.

  • message string

    A human-readable message providing more details about the error.