Monsido API (1.0.0)

Monsido Customer API

accessibility_guidelines

Operations about accessibility_guidelines

getAccessibilityGuidelines

List accessibility guidelines

Request Body schema: application/x-www-form-urlencoded

abbrs

Array of strings

filter by guideline abbr e.g. WCAG21-AAA or WCAG22-AA

Responses

Response samples

Content type

application/json

{"id": 0,
"abbr": "string",
"mobile": true,
"previous_guideline_id": 0,
"checks_count": 0,
"levels": {"name": "string",
"total": 0,
"error": 0,
"warning": 0,
"review": 0
}
}

getAccessibilityGuidelinesGuidelineId

Get accessibility guideline

path Parameters

guideline_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"id": 0,
"abbr": "string",
"mobile": true,
"previous_guideline_id": 0,
"checks_count": 0,
"levels": {"name": "string",
"total": 0,
"error": 0,
"warning": 0,
"review": 0
}
}

accessibility_checks

Operations about accessibility_checks

getAccessibilityChecks

List accessibility checks

query Parameters

search	string
impact	string Enum: "minor" "moderate" "serious" "critical"
labels	Array of integers <int32> [ items <int32 > ]
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "name" Value: "name"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"number": "string",
"result_type": "string",
"tags": ["string"
],
"difficulty": 0,
"impact": "string",
"friendly_name": "string",
"responsibilities": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"previous_check_id": "string",
"mobile": "string"
}

patchAccessibilityChecksCheckId

Update an accessibility check

path Parameters

check_id

required

integer <int32>

Request Body schema: application/json

Array

integer <int32>

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"number": "string",
"result_type": "string",
"tags": ["string"
],
"difficulty": 0,
"impact": "string",
"friendly_name": "string",
"responsibilities": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"previous_check_id": "string",
"mobile": "string"
}

accessibility

Operations about accessibilities

deleteAccessibilitySourceCodeExcludesExcludeId

Delete accessibility source code exclude

path Parameters

exclude_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

patchAccessibilitySourceCodeExcludesExcludeId

Update accessibility source code exclude

path Parameters

exclude_id

required

integer <int32>

Request Body schema: application/json

short_description	string
	Array of objects
default_for_cms	string Enum: "sitecore" "special" "custom" "dynamicweb" "umbraco" "wordpress" "wordpress_multisite" "omniupdate" "sitefinity" "publicera" "drupal" "opencities" "plone" "presence" "gabbart" "joomla" "squiz" "silverstripe" "municode" "sitevision" "kentico" "hubspot" "finalsite" "squarespace" "cascade" "elcom" "icreate" "episerver" "acos" "shopify" "adobe" "simsite" "craft" "aem" "konform" "corepublish" "cms_template" "civicengage_central" "civicengage_evolve" "civicengage_open"

Responses

Request samples

Payload

Content type

application/json

{"short_description": "string",
"match_rules": [{"type": "exact",
"value": "string",
"accessibility_check_ids": [0
]
}
],
"default_for_cms": "sitecore"
}

Response samples

Content type

application/json

{"id": "string",
"owner_type": "string",
"short_description": "string",
"match_rules": "string",
"default_for_cms": "string"
}

getAccessibilitySourceCodeExcludesExcludeId

Get accessibility source code exclude

path Parameters

exclude_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"id": "string",
"owner_type": "string",
"short_description": "string",
"match_rules": "string",
"default_for_cms": "string"
}

postAccessibilitySourceCodeExcludes

Create accessibility source code exclude

Request Body schema: application/json

short_description required	string
required	Array of objects
default_for_cms	string Enum: "sitecore" "special" "custom" "dynamicweb" "umbraco" "wordpress" "wordpress_multisite" "omniupdate" "sitefinity" "publicera" "drupal" "opencities" "plone" "presence" "gabbart" "joomla" "squiz" "silverstripe" "municode" "sitevision" "kentico" "hubspot" "finalsite" "squarespace" "cascade" "elcom" "icreate" "episerver" "acos" "shopify" "adobe" "simsite" "craft" "aem" "konform" "corepublish" "cms_template" "civicengage_central" "civicengage_evolve" "civicengage_open"

Responses

Request samples

Payload

Content type

application/json

{"short_description": "string",
"match_rules": [{"type": "exact",
"value": "string",
"accessibility_check_ids": [0
]
}
],
"default_for_cms": "sitecore"
}

Response samples

Content type

application/json

{"id": "string",
"owner_type": "string",
"short_description": "string",
"match_rules": "string",
"default_for_cms": "string"
}

getAccessibilitySourceCodeExcludes

List accessibility source code excludes

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
include_inherited	boolean Default: false
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "short_description" Enum: "id" "short_description" "tag"

Responses

Response samples

Content type

application/json

{"id": "string",
"owner_type": "string",
"short_description": "string",
"match_rules": "string",
"default_for_cms": "string"
}

account

Operations about accounts

patchAccount

Update account

Request Body schema: application/json

name	string
address	string
city	string
zipcode	string
state	string
country	string
vat_number	string
timezone	string
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address": "string",
"city": "string",
"zipcode": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"timezone": "string",
"branding": {"menu_background_color": "string"
},
"settings": {"legacy_compliance": true,
"legacy_check_compliance": true,
"legacy_seo_compliance": true,
"respect_do_not_track": true
}
}

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"settings": {"send_mail_for_potentiel_nin": true,
"send_mail_for_unlikely_nin": true,
"statistics": true,
"accessibility": "string",
"respect_do_not_track": true,
"legacy_compliance": true,
"legacy_check_compliance": true,
"legacy_seo_compliance": true,
"js_rendering_service": "string"
},
"branding": {"menu_background_color": "string"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string",
"reseller": {"id": 0,
"name": "string"
},
"html_pages_count": 0,
"documents_count": 0,
"vertical": "string"
}

getAccount

Get account

Responses

Response samples

Content type

application/json

{"id": "string",
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"settings": {"send_mail_for_potentiel_nin": true,
"send_mail_for_unlikely_nin": true,
"statistics": true,
"accessibility": "string",
"respect_do_not_track": true,
"legacy_compliance": true,
"legacy_check_compliance": true,
"legacy_seo_compliance": true,
"js_rendering_service": "string"
},
"branding": {"menu_background_color": "string"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string",
"reseller": {"id": 0,
"name": "string"
},
"html_pages_count": 0,
"documents_count": 0,
"vertical": "string"
}

comments

Operations about comments

postComments

Create comment

Request Body schema: application/json

subject_type required	string
subject_id required	integer <int32>
comment required	string

Responses

Request samples

Payload

Content type

application/json

{"subject_type": "string",
"subject_id": 0,
"comment": "string"
}

Response samples

Content type

application/json

{"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getComments

List comments

query Parameters

subject_type	string
subject_id	integer <int32>
user_id	integer <int32>
search	string
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "created_at" Value: "created_at"

Responses

Response samples

Content type

application/json

{"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteCommentsCommentId

Delete comment

path Parameters

comment_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

patchCommentsCommentId

Update comment

path Parameters

comment_id

required

integer <int32>

Request Body schema: application/json

comment

required

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

Content type

application/json

{"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getCommentsCommentId

Get comment

path Parameters

comment_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

pages

Operations about pages

getPages

List pages

query Parameters

type	string Enum: "html" "pdf" "document" Filter on type
types	Array of strings Items Enum: "html" "pdf" "document" Filter on multiple types
search required	string Title and url search
sort_by	string Default: "title" Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
notifications	boolean Filter on notifications
seo_issues	boolean Filter on seo issues
seo_issue_alerts	boolean Filter on seo issues with classification alert
seo_issue_warnings	boolean Filter on seo issues with classification warning
seo_issue_infos	boolean Filter on seo issues with classification info
seo_issue_technicals	boolean Filter on seo issues with classification technical
spelling_errors	boolean Filter on spelling errors
confirmed_spelling_errors	boolean Filter on confirmed spelling errors
potential_spelling_errors	boolean Filter on potential spelling errors
quality_notifications	boolean Filter on policy notifications
broken_links	boolean Filter on broken links
ni_numbers	boolean Filter on ni numbers
languages	Array of strings Filter on language(s)
policy_violations	boolean Filter on policy violations
policy_searches	boolean Filter on policy searches
policy_required	boolean Filter on policy required
policy_errors	boolean Filter on policy violations OR policy required
link_to	string Filter on pages with link to value
data_protection_violations	boolean Filter on pages with Data Protection violations
info_type_id	integer <int32> Filter on pages with Data Protection violations with a given Info Type
data_protection_content_id	integer <int32> Filter on pages with Data Protection violations with a given Content
data_protection_violation_id	integer <int32> Filter on pages with a given Data Protection violation

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"mrank": 0,
"hit_score": 0,
"link_score": 0,
"error_score": 0,
"priority_score": 0,
"detected_language": "string",
"language_override": "string",
"no_index": true,
"hits": 0,
"type": "string",
"dead_links_count": 0,
"ignored_links_count": 0,
"fixed_links_count": 0,
"dead_images_count": 0,
"ignored_images_count": 0,
"fixed_images_count": 0,
"seo_issues_count": 0,
"spelling_errors_count": 0,
"notification_count": 0,
"spelling_errors_confirmed_count": 0,
"spelling_errors_potential_count": 0,
"accessibility_checks_with_errors_count": 0,
"accessibility_ignored_checks_count": 0,
"nin_count": 0,
"quality_notification_count": 0,
"words_count": "string",
"readability_words_count": "string",
"language": "string",
"domain": {"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string"
},
"priority_score_as_text": "string",
"readability": 0,
"readability_level": "string",
"policy_violation_count": 0,
"policy_search_count": 0,
"policy_required_count": 0,
"lastcheck": "2019-08-24T14:15:22Z",
"latest_page_scan_status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"data_protection_violations_counts": "string",
"error_searches_count": 0,
"searches_count": 0,
"quality_notifications_not_searches": 0
}

exports

Operations about exports

postExports

Create export

Request Body schema: application/json

category required	string Enum: "dead_links" "potential_misspelling" "confirmed_misspelling" "inventory_html_pages" "inventory_documents" "inventory_images" "inventory_links" "inventory_links_to_documents" "inventory_css" "inventory_js" "inventory_form" "inventory_headlink" "inventory_iframe" "inventory_frame" "inventory_email" "seo" "accessibility_checks" "dead_images" "accessibility_summary" "policies" "policy_pages" "accessibility_pages" "seo_pages" "seo_checkpoints" "pages_with_broken_links" "pages_with_misspelling" "ni_numbers" "pages_with_qa_errors" "prioritized_pages" "pages_without_visits" "least_popular_pages" "accessibility_checks_for_page" "dead_page_links" "dead_page_images" "accessibility_pdfs" "readability_pages" "most_popular_pages" "entry_exit_entry" "entry_exit_exit" "sources_domains" "entry_exit_bounce_rates" "visitors_locations" "visitors_language" "visitors_organizations" "visitors_devices" "visitors_browsers" "visitors_os" "visitors_resolutions" "heartbeat_downtime" "scan_history_overview" "pages_documents" "pages_with_specific_link" "inventory_document_pages" "readability_by_score" "pages_with_specific_potential_misspelling" "account_dictionary" "qa_summary" "pages_with_specific_checklist_error" "spellcheck_summary" "urls_with_policy_across_domains" "heartbeat_response_time" "users_with_domain_access" "inventory_iframe_urls" "page_performance_results" "page_links_for_page" "most_downloads" "links_to_documents" "policy_links" "data_protection_violations" "content_with_data_issues" "data_protection_summary" "custom_ruleset" "advanced_policy_links" "policy_matching_terms" "inventory_email_extended" "incoming_links" "inventory_pdf_links" "page_clarity" "account_dictionary_ignored" "event_categories" "event_actions" "event_names" "site_search_keywords" "site_search_no_result_keywords"
recipients required	Array of strings array of emails
source_type	string Enum: "Domain" "DomainGroup"
source_id	integer <int32>
category_ref	string Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" "12" "13" "14" "15" "16" "17" "na" "very hard" "hard" "medium" "easy" "very easy" "no_score" "below_5th" "5th" "6th" "7th" "8th_to_9th" "10th_to_12th" "college" "college_graduate" Export category filter option(s). Value depends on export category

Responses

Request samples

Payload

Content type

application/json

{"category": "dead_links",
"recipients": ["string"
],
"source_type": "Domain",
"source_id": 0,
"category_ref": "1"
}

Response samples

Content type

application/json

{"id": "string",
"source_id": "string",
"source_type": "string",
"state": "string",
"category": "string",
"category_ref": "string",
"recipients": "string",
"data_url": "string",
"created_at": "string",
"updated_at": "string"
}

getExports

List exports

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

Content type

application/json

{"id": "string",
"source_id": "string",
"source_type": "string",
"state": "string",
"category": "string",
"category_ref": "string",
"recipients": "string",
"data_url": "string",
"created_at": "string",
"updated_at": "string"
}

getExportsExportId

Get export

path Parameters

export_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"id": "string",
"source_id": "string",
"source_type": "string",
"state": "string",
"category": "string",
"category_ref": "string",
"recipients": "string",
"data_url": "string",
"created_at": "string",
"updated_at": "string"
}

domains

Operations about domains

postDomains

Create domain

Request Body schema: application/json

title required	string
url required	string
timezone	string
active	boolean
	object
cms	string Default: "no_cms" Enum: "sitecore" "special" "custom" "dynamicweb" "umbraco" "wordpress" "wordpress_multisite" "omniupdate" "sitefinity" "publicera" "drupal" "opencities" "plone" "presence" "gabbart" "joomla" "squiz" "silverstripe" "municode" "sitevision" "kentico" "hubspot" "finalsite" "squarespace" "cascade" "elcom" "icreate" "episerver" "acos" "shopify" "adobe" "simsite" "craft" "aem" "konform" "corepublish" "cms_template" "civicengage_central" "civicengage_evolve" "civicengage_open" "no_cms"
	object
language	string
cms_extra	object
	Array of objects
	Array of objects
	Array of objects
accessibility_source_code_excludes	Array of integers <int32> [ items <int32 > ]
	Array of objects
	object
source_code_excludes	Array of integers <int32> [ items <int32 > ]
	object
labels	Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"url": "string",
"timezone": "string",
"active": true,
"scan": {"day": "any",
"scan_subdomains": false,
"connections_per_minute": 30,
"time": "23:00:00",
"scan_cpr": false,
"scan_documents": false,
"scan_interval": -1,
"auth_required_as_error": false,
"case_sensitive": true,
"spelling_ignore_capitalized_words": false,
"enable_javascript": false,
"max_scanned_pages": null,
"max_scanned_links": null,
"login": null,
"ignore_canonical": false,
"use_lang_attribute": false,
"sitemaps_from_robots": true,
"max_scan_depth": null
},
"cms": "sitecore",
"features": {"accessibility": "WCAG2-A",
"readability_test": "ari",
"readability_test_min_words": 0,
"statistics": false,
"page_assist": false,
"page_fix": false,
"data_protection": false,
"clarity_guideline": "WCAG2_0",
"cookie_banner": false
},
"language": "string",
"cms_extra": { },
"domain_users": [{"visible": true,
"send_report": true,
"user_id": 0
}
],
"path_constraints": [{"id": 0,
"constraint": "string",
"tags": ["string"
]
}
],
"link_excludes": [{"id": 0,
"regex": "string",
"tags": ["string"
]
}
],
"accessibility_source_code_excludes": [0
],
"additional_internal_urls": [{"operator": "contains",
"value": "string"
}
],
"page_assist_settings": {"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": null
}
]
}
],
"logo": "string",
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": {"scripts": {"statistics": {"enabled": true,
"cookieless_tracking": true,
"document_tracking": {"enabled": true,
"document_cls": "string",
"document_ignore_cls": "string",
"document_ext": ["string"
]
}
},
"heatmap": {"enabled": true
},
"page_correct": {"enabled": true,
"enabled_checks": ["spelling_error"
],
"admin_only": true
},
"page_assist": {"enabled": true,
"theme": "string",
"direction": "string",
"skip_to": true,
"manual_startup": true
},
"page_assist_v2": { },
"cookie_banner": { }
},
"data_protection": {"enabled": true,
"enabled_regulations": ["APA"
],
"custom_ruleset": {"extras": [0
],
"exclusions": [0
]
}
}
},
"labels": [0
]
}

Response samples

Content type

application/json

{"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string",
"timezone": "string",
"cms": 0,
"language": "string",
"customer": {"id": 0,
"name": "string",
"reseller": {"id": 0,
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"settings": {"training_request_link": "string",
"help_center_link": "string"
},
"domains_count": 0,
"customers_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string"
},
"last_scan": "string",
"crawled_pages": "string",
"crawl_status": {"step": "string",
"progress": "string"
},
"crawl_history": {"id": "string",
"date": "string",
"run_time": "string",
"queued_at": "string",
"now_processing_step": "string",
"type": "string",
"user_id": "string",
"js_rendering_service": "string",
"page_count": "string",
"dead_count": "string",
"documents_count": "string",
"links_count": "string",
"images_count": "string",
"files": "string",
"file_counts": "string",
"dead_links_count": "string",
"dead_images_count": "string",
"pages_with_errors_count": "string",
"pages_with_dead_links_count": "string",
"pages_with_dead_images_count": "string",
"pages_with_notifications_count": "string",
"policy_with_violations_count": "string",
"policy_with_search_hits_count": "string",
"policy_with_required_count": "string",
"pages_with_policy_violations_count": "string",
"pages_with_policy_searches_count": "string",
"pages_with_policy_required_count": "string",
"pages_with_policy_matches_count": "string",
"spelling_errors_count": "string",
"spelling_errors_confirmed_count": "string",
"spelling_errors_potential_count": "string",
"pages_with_spelling_errors_count": "string",
"pages_with_spelling_errors_confirmed_count": "string",
"pages_with_spelling_errors_potential_count": "string",
"accessibility_checks": "string",
"accessibility_issues": "string",
"accessiblity_issues_count": "string",
"accessibility_reviewed_documents": "string",
"accessibility_checks_by_result_type_and_abbr": "string",
"accessibility_pages_by_result_type_and_abbr": "string",
"accessibility_guideline": "string",
"seo_errors_alerts_count": "string",
"seo_errors_infos_count": "string",
"seo_errors_technical_count": "string",
"seo_errors_warnings_count": "string",
"pages_with_seo_errors_count": "string",
"pages_with_seo_errors_alerts_count": "string",
"pages_with_seo_errors_info_count": "string",
"pages_with_seo_errors_technical_count": "string",
"pages_with_seo_errors_warnings_count": "string",
"pages_with_accessibility_errors_count": "string",
"readability_test": "string",
"readability_distribution": "string",
"performance_version": "string",
"performance_page_count": "string",
"performance_profile_count": "string",
"performance_first_meaningful_paint_average": "string",
"performance_first_contentful_paint_average": "string",
"performance_largest_contentful_paint_average": "string",
"performance_speed_index_average": "string",
"performance_total_blocking_time_average": "string",
"performance_cumulative_layout_shift_average": "string",
"performance_time_to_interactive_average": "string",
"performance_score_average": "string",
"compliance_percentage": "string",
"post_processing_done_at": "2019-08-24T14:15:22Z",
"data_protection_pages_with_violations_count": "string",
"data_protection_violations_count": "string",
"data_protection_total_page_violations_count": "string",
"data_protection_active_page_violations_count": "string",
"data_protection_ignored_page_violations_count": "string",
"data_protection_fixed_page_violations_count": "string",
"data_protection_high_priority_page_violations_count": "string",
"data_protection_medium_priority_page_violations_count": "string",
"data_protection_low_priority_page_violations_count": "string",
"vertical_scores": "string",
"searches_count": 0,
"search_errors_count": 0,
"searches_with_normal_violations_count": 0,
"searches_with_unwanted_violations_count": 0,
"total_searches_count": 0,
"pages_with_searches_count": 0,
"pages_with_search_errors_count": 0
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"token": "string",
"features": {"accessibility": "string",
"readability_test": "string",
"readability_test_min_words": 0,
"statistics": true,
"page_assist": true,
"page_fix": true,
"data_protection": true,
"clarity_guideline": "string",
"cookie_banner": true
},
"scan": {"day": "string",
"scan_subdomains": true,
"parseargs": true,
"connections_per_minute": 0,
"time": "string",
"scan_cpr": true,
"scan_documents": true,
"scan_interval": 0,
"auth_required_as_error": true,
"case_sensitive": true,
"spelling_ignore_capitalized_words": true,
"enable_javascript": true,
"max_scanned_pages": 0,
"max_scanned_links": 0,
"login": {"type": "string",
"basic_auth": {"hosts": ["string"
],
"username": "string",
"password": "string"
},
"form": {"fields": {"selector": "string",
"value": "string"
},
"submit_selector": "string"
},
"office365": {"email": "string",
"password": "string",
"remember_me_step": true
},
"custom_multistep": {"username": "string",
"password": "string",
"steps": ["string"
]
},
"verify": {"location": "string"
}
},
"ignore_canonical": true,
"use_lang_attribute": true,
"sitemaps_from_robots": true,
"max_scan_depth": 0
},
"path_constraints": {"id": 0,
"constraint": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"link_excludes": {"id": 0,
"regex": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"excluded_ips": "string",
"domain_groups": {"id": "string",
"title": "string",
"description": "string",
"rules": [{"match": "string",
"match_rule": "string",
"key": "string",
"text": "string",
"label_ids": [0
],
"exclude": true
}
],
"created_at": "string",
"updated_at": "string",
"domain_group_members": [{"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
}
],
"page_count": 0,
"accessibility_checks_counters": { },
"accessibility_checks_by_result_type_and_abbr_counters": { },
"accessibility_pages_counters": { },
"accessibility_pages_by_result_type_and_abbr_counters": { }
},
"running_groups": "string",
"accessibility_source_code_excludes": [0
],
"cms_extra": "string",
"additional_internal_urls": {"operator": "string",
"value": "string"
},
"page_assist_settings": {"logo": "string",
"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": 0
}
]
}
],
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": { },
"created_at": "string",
"updated_at": "string",
"favorite": "string",
"monsido_script_installed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomains

List domains

query Parameters

labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
search	string Title, url and token search
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "title" Enum: "title" "id" "favorite"
mini	boolean Default: false

Responses

Response samples

Content type

application/json

{"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string",
"timezone": "string",
"cms": 0,
"language": "string",
"customer": {"id": 0,
"name": "string",
"reseller": {"id": 0,
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"settings": {"training_request_link": "string",
"help_center_link": "string"
},
"domains_count": 0,
"customers_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string"
},
"last_scan": "string",
"crawled_pages": "string",
"crawl_status": {"step": "string",
"progress": "string"
},
"crawl_history": {"id": "string",
"date": "string",
"run_time": "string",
"queued_at": "string",
"now_processing_step": "string",
"type": "string",
"user_id": "string",
"js_rendering_service": "string",
"page_count": "string",
"dead_count": "string",
"documents_count": "string",
"links_count": "string",
"images_count": "string",
"files": "string",
"file_counts": "string",
"dead_links_count": "string",
"dead_images_count": "string",
"pages_with_errors_count": "string",
"pages_with_dead_links_count": "string",
"pages_with_dead_images_count": "string",
"pages_with_notifications_count": "string",
"policy_with_violations_count": "string",
"policy_with_search_hits_count": "string",
"policy_with_required_count": "string",
"pages_with_policy_violations_count": "string",
"pages_with_policy_searches_count": "string",
"pages_with_policy_required_count": "string",
"pages_with_policy_matches_count": "string",
"spelling_errors_count": "string",
"spelling_errors_confirmed_count": "string",
"spelling_errors_potential_count": "string",
"pages_with_spelling_errors_count": "string",
"pages_with_spelling_errors_confirmed_count": "string",
"pages_with_spelling_errors_potential_count": "string",
"accessibility_checks": "string",
"accessibility_issues": "string",
"accessiblity_issues_count": "string",
"accessibility_reviewed_documents": "string",
"accessibility_checks_by_result_type_and_abbr": "string",
"accessibility_pages_by_result_type_and_abbr": "string",
"accessibility_guideline": "string",
"seo_errors_alerts_count": "string",
"seo_errors_infos_count": "string",
"seo_errors_technical_count": "string",
"seo_errors_warnings_count": "string",
"pages_with_seo_errors_count": "string",
"pages_with_seo_errors_alerts_count": "string",
"pages_with_seo_errors_info_count": "string",
"pages_with_seo_errors_technical_count": "string",
"pages_with_seo_errors_warnings_count": "string",
"pages_with_accessibility_errors_count": "string",
"readability_test": "string",
"readability_distribution": "string",
"performance_version": "string",
"performance_page_count": "string",
"performance_profile_count": "string",
"performance_first_meaningful_paint_average": "string",
"performance_first_contentful_paint_average": "string",
"performance_largest_contentful_paint_average": "string",
"performance_speed_index_average": "string",
"performance_total_blocking_time_average": "string",
"performance_cumulative_layout_shift_average": "string",
"performance_time_to_interactive_average": "string",
"performance_score_average": "string",
"compliance_percentage": "string",
"post_processing_done_at": "2019-08-24T14:15:22Z",
"data_protection_pages_with_violations_count": "string",
"data_protection_violations_count": "string",
"data_protection_total_page_violations_count": "string",
"data_protection_active_page_violations_count": "string",
"data_protection_ignored_page_violations_count": "string",
"data_protection_fixed_page_violations_count": "string",
"data_protection_high_priority_page_violations_count": "string",
"data_protection_medium_priority_page_violations_count": "string",
"data_protection_low_priority_page_violations_count": "string",
"vertical_scores": "string",
"searches_count": 0,
"search_errors_count": 0,
"searches_with_normal_violations_count": 0,
"searches_with_unwanted_violations_count": 0,
"total_searches_count": 0,
"pages_with_searches_count": 0,
"pages_with_search_errors_count": 0
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"token": "string",
"features": {"accessibility": "string",
"readability_test": "string",
"readability_test_min_words": 0,
"statistics": true,
"page_assist": true,
"page_fix": true,
"data_protection": true,
"clarity_guideline": "string",
"cookie_banner": true
},
"scan": {"day": "string",
"scan_subdomains": true,
"parseargs": true,
"connections_per_minute": 0,
"time": "string",
"scan_cpr": true,
"scan_documents": true,
"scan_interval": 0,
"auth_required_as_error": true,
"case_sensitive": true,
"spelling_ignore_capitalized_words": true,
"enable_javascript": true,
"max_scanned_pages": 0,
"max_scanned_links": 0,
"login": {"type": "string",
"basic_auth": {"hosts": ["string"
],
"username": "string",
"password": "string"
},
"form": {"fields": {"selector": "string",
"value": "string"
},
"submit_selector": "string"
},
"office365": {"email": "string",
"password": "string",
"remember_me_step": true
},
"custom_multistep": {"username": "string",
"password": "string",
"steps": ["string"
]
},
"verify": {"location": "string"
}
},
"ignore_canonical": true,
"use_lang_attribute": true,
"sitemaps_from_robots": true,
"max_scan_depth": 0
},
"path_constraints": {"id": 0,
"constraint": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"link_excludes": {"id": 0,
"regex": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"excluded_ips": "string",
"domain_groups": {"id": "string",
"title": "string",
"description": "string",
"rules": [{"match": "string",
"match_rule": "string",
"key": "string",
"text": "string",
"label_ids": [0
],
"exclude": true
}
],
"created_at": "string",
"updated_at": "string",
"domain_group_members": [{"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
}
],
"page_count": 0,
"accessibility_checks_counters": { },
"accessibility_checks_by_result_type_and_abbr_counters": { },
"accessibility_pages_counters": { },
"accessibility_pages_by_result_type_and_abbr_counters": { }
},
"running_groups": "string",
"accessibility_source_code_excludes": [0
],
"cms_extra": "string",
"additional_internal_urls": {"operator": "string",
"value": "string"
},
"page_assist_settings": {"logo": "string",
"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": 0
}
]
}
],
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": { },
"created_at": "string",
"updated_at": "string",
"favorite": "string",
"monsido_script_installed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

postDomainsDomainIdRescan

Start on-demand scan

path Parameters

domain_id

required

integer <int32>

query Parameters

group_id

integer <int32>

Request Body schema: application/json

callback_url	string The URL to be called with the result of the crawl upon completion
on_failure_callback_url	string The URL to be called with the result of the crawl upon failure
full_cookie_scan	boolean Default: false Scan for cookies on all pages

Responses

Request samples

Payload

Content type

application/json

{"callback_url": "string",
"on_failure_callback_url": "string",
"full_cookie_scan": false
}

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

getDomainsDomainIdFavicon

Get favicon

path Parameters

domain_id

required

integer <int32>

query Parameters

group_id

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

deleteDomainsDomainId

Delete domain

path Parameters

domain_id

required

integer <int32>

query Parameters

group_id

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

patchDomainsDomainId

Update domain

path Parameters

domain_id

required

integer <int32>

query Parameters

group_id

integer <int32>

Request Body schema: application/json

title	string
url	string
timezone	string
active	boolean
	object
cms	string
	object
language	string
cms_extra	object
	Array of objects
	Array of objects
	Array of objects
accessibility_source_code_excludes	Array of integers <int32> [ items <int32 > ]
	Array of objects
excluded_ips	string
	object
source_code_excludes	Array of integers <int32> [ items <int32 > ]
	object
labels	Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"url": "string",
"timezone": "string",
"active": true,
"scan": {"day": "any",
"scan_subdomains": false,
"connections_per_minute": 30,
"time": "23:00:00",
"scan_cpr": false,
"scan_documents": false,
"scan_interval": -1,
"auth_required_as_error": false,
"case_sensitive": true,
"spelling_ignore_capitalized_words": false,
"enable_javascript": false,
"max_scanned_pages": null,
"max_scanned_links": null,
"login": null,
"ignore_canonical": false,
"use_lang_attribute": false,
"sitemaps_from_robots": true,
"max_scan_depth": null
},
"cms": "string",
"features": {"accessibility": "WCAG2-A",
"readability_test": "ari",
"readability_test_min_words": 0,
"statistics": false,
"page_assist": false,
"page_fix": false,
"data_protection": false,
"clarity_guideline": "WCAG2_0",
"cookie_banner": false
},
"language": "string",
"cms_extra": { },
"domain_users": [{"id": 0,
"visible": true,
"send_report": true,
"user_id": 0
}
],
"path_constraints": [{"id": 0,
"constraint": "string",
"tags": ["string"
]
}
],
"link_excludes": [{"id": 0,
"regex": "string",
"tags": ["string"
]
}
],
"accessibility_source_code_excludes": [0
],
"additional_internal_urls": [{"operator": "contains",
"value": "string"
}
],
"excluded_ips": "string",
"page_assist_settings": {"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": null
}
]
}
],
"logo": "string",
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": {"scripts": {"statistics": {"enabled": true,
"cookieless_tracking": true,
"document_tracking": {"enabled": true,
"document_cls": "string",
"document_ignore_cls": "string",
"document_ext": ["string"
]
}
},
"heatmap": {"enabled": true
},
"page_correct": {"enabled": true,
"enabled_checks": ["spelling_error"
],
"admin_only": true
},
"page_assist": {"enabled": true,
"theme": "string",
"direction": "string",
"skip_to": true,
"manual_startup": true
},
"page_assist_v2": { },
"cookie_banner": { }
},
"data_protection": {"enabled": true,
"enabled_regulations": ["APA"
],
"custom_ruleset": {"extras": [0
],
"exclusions": [0
]
}
}
},
"labels": [0
]
}

Response samples

Content type

application/json

{"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string",
"timezone": "string",
"cms": 0,
"language": "string",
"customer": {"id": 0,
"name": "string",
"reseller": {"id": 0,
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"settings": {"training_request_link": "string",
"help_center_link": "string"
},
"domains_count": 0,
"customers_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string"
},
"last_scan": "string",
"crawled_pages": "string",
"crawl_status": {"step": "string",
"progress": "string"
},
"crawl_history": {"id": "string",
"date": "string",
"run_time": "string",
"queued_at": "string",
"now_processing_step": "string",
"type": "string",
"user_id": "string",
"js_rendering_service": "string",
"page_count": "string",
"dead_count": "string",
"documents_count": "string",
"links_count": "string",
"images_count": "string",
"files": "string",
"file_counts": "string",
"dead_links_count": "string",
"dead_images_count": "string",
"pages_with_errors_count": "string",
"pages_with_dead_links_count": "string",
"pages_with_dead_images_count": "string",
"pages_with_notifications_count": "string",
"policy_with_violations_count": "string",
"policy_with_search_hits_count": "string",
"policy_with_required_count": "string",
"pages_with_policy_violations_count": "string",
"pages_with_policy_searches_count": "string",
"pages_with_policy_required_count": "string",
"pages_with_policy_matches_count": "string",
"spelling_errors_count": "string",
"spelling_errors_confirmed_count": "string",
"spelling_errors_potential_count": "string",
"pages_with_spelling_errors_count": "string",
"pages_with_spelling_errors_confirmed_count": "string",
"pages_with_spelling_errors_potential_count": "string",
"accessibility_checks": "string",
"accessibility_issues": "string",
"accessiblity_issues_count": "string",
"accessibility_reviewed_documents": "string",
"accessibility_checks_by_result_type_and_abbr": "string",
"accessibility_pages_by_result_type_and_abbr": "string",
"accessibility_guideline": "string",
"seo_errors_alerts_count": "string",
"seo_errors_infos_count": "string",
"seo_errors_technical_count": "string",
"seo_errors_warnings_count": "string",
"pages_with_seo_errors_count": "string",
"pages_with_seo_errors_alerts_count": "string",
"pages_with_seo_errors_info_count": "string",
"pages_with_seo_errors_technical_count": "string",
"pages_with_seo_errors_warnings_count": "string",
"pages_with_accessibility_errors_count": "string",
"readability_test": "string",
"readability_distribution": "string",
"performance_version": "string",
"performance_page_count": "string",
"performance_profile_count": "string",
"performance_first_meaningful_paint_average": "string",
"performance_first_contentful_paint_average": "string",
"performance_largest_contentful_paint_average": "string",
"performance_speed_index_average": "string",
"performance_total_blocking_time_average": "string",
"performance_cumulative_layout_shift_average": "string",
"performance_time_to_interactive_average": "string",
"performance_score_average": "string",
"compliance_percentage": "string",
"post_processing_done_at": "2019-08-24T14:15:22Z",
"data_protection_pages_with_violations_count": "string",
"data_protection_violations_count": "string",
"data_protection_total_page_violations_count": "string",
"data_protection_active_page_violations_count": "string",
"data_protection_ignored_page_violations_count": "string",
"data_protection_fixed_page_violations_count": "string",
"data_protection_high_priority_page_violations_count": "string",
"data_protection_medium_priority_page_violations_count": "string",
"data_protection_low_priority_page_violations_count": "string",
"vertical_scores": "string",
"searches_count": 0,
"search_errors_count": 0,
"searches_with_normal_violations_count": 0,
"searches_with_unwanted_violations_count": 0,
"total_searches_count": 0,
"pages_with_searches_count": 0,
"pages_with_search_errors_count": 0
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"token": "string",
"features": {"accessibility": "string",
"readability_test": "string",
"readability_test_min_words": 0,
"statistics": true,
"page_assist": true,
"page_fix": true,
"data_protection": true,
"clarity_guideline": "string",
"cookie_banner": true
},
"scan": {"day": "string",
"scan_subdomains": true,
"parseargs": true,
"connections_per_minute": 0,
"time": "string",
"scan_cpr": true,
"scan_documents": true,
"scan_interval": 0,
"auth_required_as_error": true,
"case_sensitive": true,
"spelling_ignore_capitalized_words": true,
"enable_javascript": true,
"max_scanned_pages": 0,
"max_scanned_links": 0,
"login": {"type": "string",
"basic_auth": {"hosts": ["string"
],
"username": "string",
"password": "string"
},
"form": {"fields": {"selector": "string",
"value": "string"
},
"submit_selector": "string"
},
"office365": {"email": "string",
"password": "string",
"remember_me_step": true
},
"custom_multistep": {"username": "string",
"password": "string",
"steps": ["string"
]
},
"verify": {"location": "string"
}
},
"ignore_canonical": true,
"use_lang_attribute": true,
"sitemaps_from_robots": true,
"max_scan_depth": 0
},
"path_constraints": {"id": 0,
"constraint": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"link_excludes": {"id": 0,
"regex": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"excluded_ips": "string",
"domain_groups": {"id": "string",
"title": "string",
"description": "string",
"rules": [{"match": "string",
"match_rule": "string",
"key": "string",
"text": "string",
"label_ids": [0
],
"exclude": true
}
],
"created_at": "string",
"updated_at": "string",
"domain_group_members": [{"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
}
],
"page_count": 0,
"accessibility_checks_counters": { },
"accessibility_checks_by_result_type_and_abbr_counters": { },
"accessibility_pages_counters": { },
"accessibility_pages_by_result_type_and_abbr_counters": { }
},
"running_groups": "string",
"accessibility_source_code_excludes": [0
],
"cms_extra": "string",
"additional_internal_urls": {"operator": "string",
"value": "string"
},
"page_assist_settings": {"logo": "string",
"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": 0
}
]
}
],
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": { },
"created_at": "string",
"updated_at": "string",
"favorite": "string",
"monsido_script_installed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainId

Get domain

path Parameters

domain_id

required

integer <int32>

query Parameters

group_id	integer <int32>
extended	boolean Default: true

Responses

Response samples

Content type

application/json

{"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string",
"timezone": "string",
"cms": 0,
"language": "string",
"customer": {"id": 0,
"name": "string",
"reseller": {"id": 0,
"name": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"settings": {"training_request_link": "string",
"help_center_link": "string"
},
"domains_count": 0,
"customers_count": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"plan_traits": {"accessibility": true,
"accessibility_summary": true,
"account_settings": true,
"api_users": true,
"clarity_pdf_accessibility": true,
"clarity_pdf_remediation": true,
"closed_caption": true,
"cookie_banner": true,
"custom_crawl_callback": true,
"custom_scan_interval": true,
"dashboard_important_notifications": true,
"data_export": true,
"data_protection": true,
"domain_group_statistics": true,
"general_book_training": true,
"general_chat_support": true,
"general_shortcuts": true,
"heartbeat": true,
"heatmap_click": true,
"heatmap_movement": true,
"heatmap_scroll": true,
"heatmaps_monthly_page_sessions": 0,
"heatmaps_monthly_sessions": 0,
"heatmaps_tracked_number_of_pages": 0,
"heatmaps_traffic_percentage": 0,
"history_center_all": true,
"inventory_all": true,
"max_domains": 0,
"max_scanned_pages": 0,
"mobile_guidelines": true,
"monsido_score": true,
"nag_for_upgrade": true,
"on_demand_scans": 0,
"page_assist": true,
"page_details": true,
"page_fix": true,
"paying": true,
"performance_tracking": true,
"performance_tracking_allowed_frequencies": [0
],
"performance_tracking_max_page_profiles": 0,
"performance_tracking_max_pages": 0,
"performance_tracking_max_profiles": 0,
"performance_tracking_on_demand_scan": true,
"policies_all": true,
"prioritized_content_all": true,
"qa_links": true,
"qa_spellcheck": true,
"qa_summary": true,
"quick_search": true,
"readability": true,
"report_center_all": true,
"scan_interval": 0,
"script_setup_guide": true,
"seo_all": true,
"single_page_scan_any_url": true,
"skip_on_hold": true,
"source_code_excludes": true,
"spell_check_engine_priority": ["string"
],
"statistics": true,
"tracking_downcase_urls": true,
"uptime_intervals": [0
]
},
"plan_type": "string"
},
"last_scan": "string",
"crawled_pages": "string",
"crawl_status": {"step": "string",
"progress": "string"
},
"crawl_history": {"id": "string",
"date": "string",
"run_time": "string",
"queued_at": "string",
"now_processing_step": "string",
"type": "string",
"user_id": "string",
"js_rendering_service": "string",
"page_count": "string",
"dead_count": "string",
"documents_count": "string",
"links_count": "string",
"images_count": "string",
"files": "string",
"file_counts": "string",
"dead_links_count": "string",
"dead_images_count": "string",
"pages_with_errors_count": "string",
"pages_with_dead_links_count": "string",
"pages_with_dead_images_count": "string",
"pages_with_notifications_count": "string",
"policy_with_violations_count": "string",
"policy_with_search_hits_count": "string",
"policy_with_required_count": "string",
"pages_with_policy_violations_count": "string",
"pages_with_policy_searches_count": "string",
"pages_with_policy_required_count": "string",
"pages_with_policy_matches_count": "string",
"spelling_errors_count": "string",
"spelling_errors_confirmed_count": "string",
"spelling_errors_potential_count": "string",
"pages_with_spelling_errors_count": "string",
"pages_with_spelling_errors_confirmed_count": "string",
"pages_with_spelling_errors_potential_count": "string",
"accessibility_checks": "string",
"accessibility_issues": "string",
"accessiblity_issues_count": "string",
"accessibility_reviewed_documents": "string",
"accessibility_checks_by_result_type_and_abbr": "string",
"accessibility_pages_by_result_type_and_abbr": "string",
"accessibility_guideline": "string",
"seo_errors_alerts_count": "string",
"seo_errors_infos_count": "string",
"seo_errors_technical_count": "string",
"seo_errors_warnings_count": "string",
"pages_with_seo_errors_count": "string",
"pages_with_seo_errors_alerts_count": "string",
"pages_with_seo_errors_info_count": "string",
"pages_with_seo_errors_technical_count": "string",
"pages_with_seo_errors_warnings_count": "string",
"pages_with_accessibility_errors_count": "string",
"readability_test": "string",
"readability_distribution": "string",
"performance_version": "string",
"performance_page_count": "string",
"performance_profile_count": "string",
"performance_first_meaningful_paint_average": "string",
"performance_first_contentful_paint_average": "string",
"performance_largest_contentful_paint_average": "string",
"performance_speed_index_average": "string",
"performance_total_blocking_time_average": "string",
"performance_cumulative_layout_shift_average": "string",
"performance_time_to_interactive_average": "string",
"performance_score_average": "string",
"compliance_percentage": "string",
"post_processing_done_at": "2019-08-24T14:15:22Z",
"data_protection_pages_with_violations_count": "string",
"data_protection_violations_count": "string",
"data_protection_total_page_violations_count": "string",
"data_protection_active_page_violations_count": "string",
"data_protection_ignored_page_violations_count": "string",
"data_protection_fixed_page_violations_count": "string",
"data_protection_high_priority_page_violations_count": "string",
"data_protection_medium_priority_page_violations_count": "string",
"data_protection_low_priority_page_violations_count": "string",
"vertical_scores": "string",
"searches_count": 0,
"search_errors_count": 0,
"searches_with_normal_violations_count": 0,
"searches_with_unwanted_violations_count": 0,
"total_searches_count": 0,
"pages_with_searches_count": 0,
"pages_with_search_errors_count": 0
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"token": "string",
"features": {"accessibility": "string",
"readability_test": "string",
"readability_test_min_words": 0,
"statistics": true,
"page_assist": true,
"page_fix": true,
"data_protection": true,
"clarity_guideline": "string",
"cookie_banner": true
},
"scan": {"day": "string",
"scan_subdomains": true,
"parseargs": true,
"connections_per_minute": 0,
"time": "string",
"scan_cpr": true,
"scan_documents": true,
"scan_interval": 0,
"auth_required_as_error": true,
"case_sensitive": true,
"spelling_ignore_capitalized_words": true,
"enable_javascript": true,
"max_scanned_pages": 0,
"max_scanned_links": 0,
"login": {"type": "string",
"basic_auth": {"hosts": ["string"
],
"username": "string",
"password": "string"
},
"form": {"fields": {"selector": "string",
"value": "string"
},
"submit_selector": "string"
},
"office365": {"email": "string",
"password": "string",
"remember_me_step": true
},
"custom_multistep": {"username": "string",
"password": "string",
"steps": ["string"
]
},
"verify": {"location": "string"
}
},
"ignore_canonical": true,
"use_lang_attribute": true,
"sitemaps_from_robots": true,
"max_scan_depth": 0
},
"path_constraints": {"id": 0,
"constraint": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"link_excludes": {"id": 0,
"regex": "string",
"created_at": "string",
"updated_at": "string",
"tags": ["string"
]
},
"excluded_ips": "string",
"domain_groups": {"id": "string",
"title": "string",
"description": "string",
"rules": [{"match": "string",
"match_rule": "string",
"key": "string",
"text": "string",
"label_ids": [0
],
"exclude": true
}
],
"created_at": "string",
"updated_at": "string",
"domain_group_members": [{"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
}
],
"page_count": 0,
"accessibility_checks_counters": { },
"accessibility_checks_by_result_type_and_abbr_counters": { },
"accessibility_pages_counters": { },
"accessibility_pages_by_result_type_and_abbr_counters": { }
},
"running_groups": "string",
"accessibility_source_code_excludes": [0
],
"cms_extra": "string",
"additional_internal_urls": {"operator": "string",
"value": "string"
},
"page_assist_settings": {"logo": "string",
"navigation": [{"title": "string",
"mainselector": "string",
"selectors": ["string"
],
"custom_navigation": [{"url": "string",
"title": "string",
"target": "string",
"mainselector": "string",
"selectors": ["string"
],
"parent_index": 0
}
]
}
],
"main": "string",
"elements_to_hide": ["string"
],
"theme": "string",
"style": "string",
"link_to_forms": true
},
"source_code_excludes": [0
],
"settings": { },
"created_at": "string",
"updated_at": "string",
"favorite": "string",
"monsido_script_installed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdAccessibilityChecks

Get accessibility checks

path Parameters

domain_id

required

integer <int32>

query Parameters

abbr	string Enum: "508" "A" "AA" "AAA"
type	string Enum: "error" "warning" "review"
responsibility	string Enum: "Visual Design" "UX Design" "Content Authoring" "Front-end Development"
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"number": "string",
"result_type": "string",
"tags": ["string"
],
"difficulty": 0,
"impact": "string",
"friendly_name": "string",
"responsibilities": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"previous_check_id": "string",
"mobile": "string",
"errors_count": 0,
"comments": {"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"issue_number": "string",
"issue_abbr": "string",
"ignored": "string",
"pages_count": 0
}

getDomainsDomainIdAccessibilityChecksAccessibilityCheckIdPages

List pages for a accessibility check

path Parameters

accessibility_check_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

type	string Enum: "html" "pdf" "document" Filter on type
types	Array of strings Items Enum: "html" "pdf" "document" Filter on multiple types
search	string Title and url search
sort_by	string Default: "title" Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
notifications	boolean Filter on notifications
seo_issues	boolean Filter on seo issues
seo_issue_alerts	boolean Filter on seo issues with classification alert
seo_issue_warnings	boolean Filter on seo issues with classification warning
seo_issue_infos	boolean Filter on seo issues with classification info
seo_issue_technicals	boolean Filter on seo issues with classification technical
spelling_errors	boolean Filter on spelling errors
confirmed_spelling_errors	boolean Filter on confirmed spelling errors
potential_spelling_errors	boolean Filter on potential spelling errors
quality_notifications	boolean Filter on policy notifications
broken_links	boolean Filter on broken links
ni_numbers	boolean Filter on ni numbers
languages	Array of strings Filter on language(s)
policy_violations	boolean Filter on policy violations
policy_searches	boolean Filter on policy searches
policy_required	boolean Filter on policy required
policy_errors	boolean Filter on policy violations OR policy required
link_to	string Filter on pages with link to value
data_protection_violations	boolean Filter on pages with Data Protection violations
info_type_id	integer <int32> Filter on pages with Data Protection violations with a given Info Type
data_protection_content_id	integer <int32> Filter on pages with Data Protection violations with a given Content
data_protection_violation_id	integer <int32> Filter on pages with a given Data Protection violation

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"mrank": 0,
"hit_score": 0,
"link_score": 0,
"error_score": 0,
"priority_score": 0,
"detected_language": "string",
"language_override": "string",
"no_index": true,
"hits": 0,
"type": "string",
"dead_links_count": 0,
"ignored_links_count": 0,
"fixed_links_count": 0,
"dead_images_count": 0,
"ignored_images_count": 0,
"fixed_images_count": 0,
"seo_issues_count": 0,
"spelling_errors_count": 0,
"notification_count": 0,
"spelling_errors_confirmed_count": 0,
"spelling_errors_potential_count": 0,
"accessibility_checks_with_errors_count": 0,
"accessibility_ignored_checks_count": 0,
"nin_count": 0,
"quality_notification_count": 0,
"words_count": "string",
"readability_words_count": "string",
"language": "string",
"domain": {"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string"
},
"priority_score_as_text": "string",
"readability": 0,
"readability_level": "string",
"policy_violation_count": 0,
"policy_search_count": 0,
"policy_required_count": 0,
"lastcheck": "2019-08-24T14:15:22Z",
"latest_page_scan_status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"data_protection_violations_counts": "string",
"error_searches_count": 0,
"searches_count": 0,
"quality_notifications_not_searches": 0
}

getDomainsDomainIdAccessibilityChecksAccessibilityCheckIdHelp

Get check help information

path Parameters

accessibility_check_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

Content type

application/json

{"guidelines": "string",
"success_criteria": "string",
"quick_guide": "string",
"short_description": "string",
"how_to_repair": "string",
"pass_examples": "string",
"fail_examples": "string",
"others": "string",
"html_element": "string",
"article_url": "string",
"check": "string",
"suggestion": "string"
}

patchDomainsDomainIdAccessibilityChecksAccessibilityCheckId

Update accessibility check

path Parameters

accessibility_check_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

ignored required	boolean
comment	string

Responses

Request samples

Payload

Content type

application/json

{"ignored": true,
"comment": "string"
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"number": "string",
"result_type": "string",
"tags": ["string"
],
"difficulty": 0,
"impact": "string",
"friendly_name": "string",
"responsibilities": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"previous_check_id": "string",
"mobile": "string",
"errors_count": 0,
"comments": {"id": "string",
"user_id": "string",
"subject_id": "string",
"subject_type": "string",
"comment": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdAccessibilityIgnoredChecksPages

Get pages with ignored accessibility checks

path Parameters

domain_id

required

integer <int32>

query Parameters

type	string Enum: "html" "pdf" "document" Filter on type
types	Array of strings Items Enum: "html" "pdf" "document" Filter on multiple types
search	string Title and url search
sort_by	string Default: "title" Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
notifications	boolean Filter on notifications
seo_issues	boolean Filter on seo issues
seo_issue_alerts	boolean Filter on seo issues with classification alert
seo_issue_warnings	boolean Filter on seo issues with classification warning
seo_issue_infos	boolean Filter on seo issues with classification info
seo_issue_technicals	boolean Filter on seo issues with classification technical
spelling_errors	boolean Filter on spelling errors
confirmed_spelling_errors	boolean Filter on confirmed spelling errors
potential_spelling_errors	boolean Filter on potential spelling errors
quality_notifications	boolean Filter on policy notifications
broken_links	boolean Filter on broken links
ni_numbers	boolean Filter on ni numbers
languages	Array of strings Filter on language(s)
policy_violations	boolean Filter on policy violations
policy_searches	boolean Filter on policy searches
policy_required	boolean Filter on policy required
policy_errors	boolean Filter on policy violations OR policy required
link_to	string Filter on pages with link to value
data_protection_violations	boolean Filter on pages with Data Protection violations
info_type_id	integer <int32> Filter on pages with Data Protection violations with a given Info Type
data_protection_content_id	integer <int32> Filter on pages with Data Protection violations with a given Content
data_protection_violation_id	integer <int32> Filter on pages with a given Data Protection violation

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"mrank": 0,
"hit_score": 0,
"link_score": 0,
"error_score": 0,
"priority_score": 0,
"detected_language": "string",
"language_override": "string",
"no_index": true,
"hits": 0,
"type": "string",
"dead_links_count": 0,
"ignored_links_count": 0,
"fixed_links_count": 0,
"dead_images_count": 0,
"ignored_images_count": 0,
"fixed_images_count": 0,
"seo_issues_count": 0,
"spelling_errors_count": 0,
"notification_count": 0,
"spelling_errors_confirmed_count": 0,
"spelling_errors_potential_count": 0,
"accessibility_checks_with_errors_count": 0,
"accessibility_ignored_checks_count": 0,
"nin_count": 0,
"quality_notification_count": 0,
"words_count": "string",
"readability_words_count": "string",
"language": "string",
"domain": {"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string"
},
"priority_score_as_text": "string",
"readability": 0,
"readability_level": "string",
"policy_violation_count": 0,
"policy_search_count": 0,
"policy_required_count": 0,
"lastcheck": "2019-08-24T14:15:22Z",
"latest_page_scan_status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"data_protection_violations_counts": "string",
"error_searches_count": 0,
"searches_count": 0,
"quality_notifications_not_searches": 0
}

getDomainsDomainIdAccessibilityPages

List pages

path Parameters

domain_id

required

integer <int32>

query Parameters

type	string Enum: "html" "pdf" "document" Filter on type
types	Array of strings Items Enum: "html" "pdf" "document" Filter on multiple types
search	string Title and url search
sort_by	string Default: "title" Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
notifications	boolean Filter on notifications
seo_issues	boolean Filter on seo issues
seo_issue_alerts	boolean Filter on seo issues with classification alert
seo_issue_warnings	boolean Filter on seo issues with classification warning
seo_issue_infos	boolean Filter on seo issues with classification info
seo_issue_technicals	boolean Filter on seo issues with classification technical
spelling_errors	boolean Filter on spelling errors
confirmed_spelling_errors	boolean Filter on confirmed spelling errors
potential_spelling_errors	boolean Filter on potential spelling errors
quality_notifications	boolean Filter on policy notifications
broken_links	boolean Filter on broken links
ni_numbers	boolean Filter on ni numbers
languages	Array of strings Filter on language(s)
policy_violations	boolean Filter on policy violations
policy_searches	boolean Filter on policy searches
policy_required	boolean Filter on policy required
policy_errors	boolean Filter on policy violations OR policy required
link_to	string Filter on pages with link to value
data_protection_violations	boolean Filter on pages with Data Protection violations
info_type_id	integer <int32> Filter on pages with Data Protection violations with a given Info Type
data_protection_content_id	integer <int32> Filter on pages with Data Protection violations with a given Content
data_protection_violation_id	integer <int32> Filter on pages with a given Data Protection violation
abbr	Array of strings Items Enum: "508" "A" "AA" "AAA"
result_type	Array of strings Items Enum: "error" "warning" "review"
mobile	boolean if true, returns only pages containing mobile accessibility errors (may include desktop). if false, returns only pages containing desktop accessibility errors (may include mobile)

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"mrank": 0,
"hit_score": 0,
"link_score": 0,
"error_score": 0,
"priority_score": 0,
"detected_language": "string",
"language_override": "string",
"no_index": true,
"hits": 0,
"type": "string",
"dead_links_count": 0,
"ignored_links_count": 0,
"fixed_links_count": 0,
"dead_images_count": 0,
"ignored_images_count": 0,
"fixed_images_count": 0,
"seo_issues_count": 0,
"spelling_errors_count": 0,
"notification_count": 0,
"spelling_errors_confirmed_count": 0,
"spelling_errors_potential_count": 0,
"accessibility_checks_with_errors_count": 0,
"accessibility_ignored_checks_count": 0,
"nin_count": 0,
"quality_notification_count": 0,
"words_count": "string",
"readability_words_count": "string",
"language": "string",
"domain": {"active": true,
"id": 0,
"customer_id": 0,
"title": "string",
"url": "string"
},
"priority_score_as_text": "string",
"readability": 0,
"readability_level": "string",
"policy_violation_count": 0,
"policy_search_count": 0,
"policy_required_count": 0,
"lastcheck": "2019-08-24T14:15:22Z",
"latest_page_scan_status": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"data_protection_violations_counts": "string",
"error_searches_count": 0,
"searches_count": 0,
"quality_notifications_not_searches": 0
}

postDomainsDomainIdAccessibilityPdfsClarityRemediation

Request Clarity remediation for all domain PDFs

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

postDomainsDomainIdAccessibilityPdfsClarityReport

Queue all domain PDFs for Clarity ADA report

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

postDomainsDomainIdAccessibilityPdfsReviewAll

Mark all domain PDFs as reviewed

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

Content type

application/json

{"message": "string",
"errors": "string"
}

getDomainsDomainIdAccessibilityPdfs

List PDF documents

path Parameters

domain_id

required

integer <int32>

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_by	string Default: "title" Enum: "title" "pages_count" "reviewed" "word_count" "content_length" "created_at"
sort_dir	string Default: "asc" Enum: "asc" "desc"
reviewed	boolean
clarity	string Enum: "pending" "queued" "failed" "reviewed"
search	string

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"reviewed": true,
"content_length": 0,
"pages_count": 0,
"word_count": 0,
"clarity_accessibility_errors_count": 0,
"clarity_accessibility_checks_with_errors_count": 0,
"clarity_tagged": true,
"clarity_queued_at": "string",
"clarity_checked_at": "string",
"clarity_remediated": true,
"created_at": "2019-08-24T14:15:22Z",
"standard": "string"
}

postDomainsDomainIdAccessibilityPdfsPdfIdClarityRemediation

Request Clarity remediation

path Parameters

pdf_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

Content type

application/json

{"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
"reviewed": true,
"content_length": 0,
"pages_count": 0,
"word_count": 0,
"clarity_accessibility_errors_count": 0,
"clarity_accessibility_checks_with_errors_count": 0,
"clarity_tagged": true,
"clarity_queued_at":