Warning This document has not been updated for a while now. It may be out of date.

Last updated: 5 Jul 2023

siteimprove_api_client: SiteimproveAPIClient::ApiReadabilityPageAutomatedReadability

Properties

Name	Type	Description	Notes
id	Integer	Id of page.
title	String	Title of the page	[optional]
url	String	URL for the live version of the page.	[optional]
automated_readability_score	Float	Automated readability index is calculated using: 4.71*(chars_with_digits / words) + 0.5*(words / sentences_with_digits) - 21.43	[optional]
chars_with_digits	Integer	Number of characters (including digits)
checking_now	Boolean	Is true if page is being checked now; otherwise false.
cms_url	String	Url for the cms entry for editing the page.	[optional]
long_sentences_with_digits_unique	Integer	Number of unique long sentences (including digits).
long_words_unique	Integer	Number of unique long words.
page_level	Integer	Page level in site hierarchy.	[optional]
page_views	Integer	Number of times this page has been viewed	[optional]
sentences_with_digits	Integer	Number of sentences (including digits).
words	Integer	Number of words.
_siteimprove	Siteimprove2		[optional]

Example

require 'siteimprove_api_client'

instance = SiteimproveAPIClient::ApiReadabilityPageAutomatedReadability.new(
  id: null,
  title: null,
  url: null,
  automated_readability_score: null,
  chars_with_digits: null,
  checking_now: null,
  cms_url: null,
  long_sentences_with_digits_unique: null,
  long_words_unique: null,
  page_level: null,
  page_views: null,
  sentences_with_digits: null,
  words: null,
  _siteimprove: null
)