Monsido API (1.0.0)

Terms of Service

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

200
403

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

200
403
404

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

200
403

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

200
403
404

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

403
404

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

200
400
403
404

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

200
403
404

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

201
400
403

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

200
403

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

200
403

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

200
403

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

201
400
403

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

200
403

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

403
404

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

200
400
403
404

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

200
403
404

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

200
403

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

201
400
403

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

200
403

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

200
403
404

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

201
400
403

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

200
403

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

403
404

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

403
404

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

403
404

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

200
400
403
404

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

200
403
404

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

200
403

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

200
403
404

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

200
403
404

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

200
403

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

200
403

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

200
403

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

403
404

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

403
404

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

403
404

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

200
403

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

201
403
404

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"
}

postDomainsDomainIdAccessibilityPdfsPdfIdClarityReport

Queue PDF for Clarity ADA report

path Parameters

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

Responses

Response samples

201
403
404

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"
}

patchDomainsDomainIdAccessibilityPdfsPdfId

Update a PDF (set reviewed)

path Parameters

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

Request Body schema: application/json

reviewed required	boolean
comment	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
403
404

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"
}

getDomainsDomainIdAccessibilityGroups

Get accessibility groups

path Parameters

domain_id

required

integer <int32>

query Parameters

abbr	string Enum: "508" "A" "AA" "AAA"
result_type	string Enum: "error" "warning" "review"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"number": "string",
"name": "string",
"abbr": "string",
"subgroups": "string"
}

getDomainsDomainIdAccessibilityGroupsAccessibilityGroupIdSubgroupsSubgroupIdChecks

get check for a subgroup

path Parameters

accessibility_group_id required	integer <int32>
subgroup_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

classification

string

Enum: "error" "warning" "review"

Responses

Response samples

200
403

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"
}
}

getDomainsDomainIdAccessibilityFastTrack

Get accessibility fast_track

path Parameters

domain_id

required

integer <int32>

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"caused_issues": 0,
"effect_on_compliance": 0,
"source_code": "string",
"created_at": "2019-08-24T14:15:22Z"
}

postDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeIdClosedCaption

Submit closed-caption request for video

path Parameters

accessibility_source_code_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeId

Get accessibility fast_track source-code

path Parameters

accessibility_source_code_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"caused_issues": 0,
"effect_on_compliance": 0,
"source_code": "string",
"created_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeIdChecks

get checks for a accessibility source code

path Parameters

domain_id required	integer <int32>
accessibility_source_code_id required	integer <int32>

query Parameters

responsibility

string

Enum: "Visual Design" "UX Design" "Content Authoring" "Front-end Development"

Responses

Response samples

200
403

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",
"pages_count": "string"
}

deleteDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeIdChecksCheckIdPages

Mark a accessibility check fixed for a source code on all pages

path Parameters

check_id required	integer <int32>
domain_id required	integer <int32>
accessibility_source_code_id required	integer <int32>

query Parameters

comment

string

Responses

Response samples

403

Content type

application/json

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

getDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeIdChecksCheckIdPages

get pages for a accessibility check

path Parameters

check_id required	integer <int32>
domain_id required	integer <int32>
accessibility_source_code_id required	integer <int32>

query Parameters

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"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

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
}

patchDomainsDomainIdAccessibilityFastTrackAccessibilitySourceCodeIdChecksCheckId

ignore/unignore an accessibility check for a source code

path Parameters

check_id required	integer <int32>
domain_id required	integer <int32>
accessibility_source_code_id required	integer <int32>

Request Body schema: application/json

comment	string
ignored_reviewed	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
403

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"
}
}

getDomainsDomainIdAccessibilitySummary

Get a summary for accessibility

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"checks": 0,
"checks_by_abbr": { },
"checks_by_result_type": 0,
"pages": 0,
"pages_by_result_type": 0,
"pages_with_issues": 0,
"checks_with_issues_by_result_type": 0,
"checks_with_issues": 0,
"checks_with_issues_by_abbr": { },
"internal_pdf": 0,
"external_pdf": 0,
"pages_by_result_type_and_abbr": { },
"checks_with_issues_by_result_type_and_abbr": { }
}

getDomainsDomainIdClarityChecks

Get Clarity accessibility checks

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"name": "string",
"errors_count": "string",
"pages_count": "string"
}

getDomainsDomainIdClarityChecksClarityAccessibilityCheckIdPdfs

Get Clarity accessibility check

path Parameters

clarity_accessibility_check_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

sort_by	string Default: "title" Enum: "title" "pages_count" "reviewed" "word_count" "errors_count" "content_length" "created_at"
sort_dir	string Default: "asc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"name": "string",
"errors_count": "string",
"pages_count": "string"
}

getDomainsDomainIdClarityChecksClarityAccessibilityCheckId

Get Clarity accessibility check

path Parameters

clarity_accessibility_check_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"name": "string",
"errors_count": "string",
"pages_count": "string"
}

getDomainsDomainIdClarityGroups

Get Clarity accessibility groups

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"name": "string"
}

getDomainsDomainIdClaritySummary

Get a summary for Clarity accessibility

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200

Content type

application/json

{"checks": "string",
"pdfs": "string",
"pdfs_with_issues": "string",
"pdfs_with_issues_by_result_type": "string",
"checks_with_issues": "string",
"checks_with_issues_by_result_type": "string",
"queued_count": 0,
"tokens": 0
}

deleteDomainsDomainIdPageFixes

Delete page_fixes

path Parameters

domain_id

required

integer <int32>

query Parameters

fixable_type

required

string

Enum: "spelling_error" "link" "accessibility_source_code" "accessibility_check" "custom" "all"

Responses

Response samples

403

Content type

application/json

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

postDomainsDomainIdPageFixes

create a fix for page_fixes

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

selector required	string
change_type required	string
required	object
fixable_type	string Enum: "spelling_error" "link" "accessibility_source_code" "accessibility_check"
fixable_id required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"selector": "string",
"change_type": "string",
"change": {"value": "string",
"attribute": "string",
"check_id": 0,
"target": "string"
},
"fixable_type": "spelling_error",
"fixable_id": 0
}

Response samples

201
403
404

Content type

application/json

{"id": "string",
"fixable_id": "string",
"customer_id": "string",
"fixable_type": "string",
"change_type": "string",
"selector": "string",
"change": "string",
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdPageFixes

List fixes for page_fixes

path Parameters

domain_id

required

integer <int32>

query Parameters

fixable_type	string Enum: "spelling_error" "link" "accessibility_source_code" "accessibility_check" "custom"
selector	string
change_type	string
search	string
fixable_id	integer <int32>
sort_by	string Default: "created_at" Enum: "created_at" "updated_at"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"fixable_id": "string",
"customer_id": "string",
"fixable_type": "string",
"change_type": "string",
"selector": "string",
"change": "string",
"created_at": "string",
"updated_at": "string"
}

patchDomainsDomainIdPageFixesFixId

update a page_fixes fix

path Parameters

fix_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

selector	string
required	object

Responses

Request samples

Payload

Content type

application/json

{"selector": "string",
"change": {"value": "string",
"attribute": "string",
"check_id": 0,
"target": "string"
}
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"fixable_id": "string",
"customer_id": "string",
"fixable_type": "string",
"change_type": "string",
"selector": "string",
"change": "string",
"created_at": "string",
"updated_at": "string"
}

deleteDomainsDomainIdPageFixesFixId

delete a pagefix fix

path Parameters

fix_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

postDomainsDomainIdCookieBannerCookies

create a domain cookie

path Parameters

domain_id

required

integer <int32>

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

name required	string
domain	string
expirations[language] required	Array of strings Items Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SY" "ar_TN" "ar_YE" "as_IN" "az_Latn_AZ" "be_BY" "bg_BG" "bn_BD" "bn_IN" "bs_Latn_BA" "ca_ES" "ca_ES_valencia" "cs_CZ" "cy_GB" "da_DK" "de_AT" "de_CH" "de_DE" "de_LI" "de_LU" "el_GR" "en_029" "en_AU" "en_BZ" "en_CA" "en_GB" "en_HK" "en_ID" "en_IE" "en_IN" "en_JM" "en_LR" "en_MY" "en_NZ" "en_PH" "en_SG" "en_TT" "en_US" "en_ZA" "en_ZW" "es_419" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_ES_tradnl" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "eu_ES" "fa_IR" "fi_FI" "fr_015" "fr_029" "fr_BE" "fr_CA" "fr_CD" "fr_CH" "fr_CI" "fr_CM" "fr_FR" "fr_HT" "fr_LU" "fr_MA" "fr_MC" "fr_ML" "fr_RE" "fr_SN" "ga_IE" "gd_GB" "gl_ES" "gu_IN" "ha_Latn_NG" "he_IL" "hi_IN" "hr_BA" "hr_HR" "hu_HU" "hy_AM" "id_ID" "ig_NG" "is_IS" "it_CH" "it_IT" "ja_JP" "ja_Latn_JP_x_ext" "ka_GE" "kk_KZ" "km_KH" "kn_IN" "kok_Deva_IN" "ky_KG" "lb_LU" "lt_LT" "lv_LV" "mi_NZ" "mk_MK" "ml_IN" "mr_IN" "ms_BN" "ms_MY" "mt_MT" "nb_NO" "ne_IN" "ne_NP" "nl_BE" "nl_NL" "nn_NO" "nso_ZA" "or_IN" "pa_IN" "pl_PL" "ps_AF" "pt_BR" "pt_PT" "rm_CH" "ro_MO" "ro_RO" "ru_MO" "ru_RU" "rw_RW" "si_LK" "sk_SK" "sl_SI" "sq_AL" "sr_Cyrl_BA" "sr_Cyrl_CS" "sr_Cyrl_ME" "sr_Cyrl_RS" "sr_Latn_BA" "sr_Latn_CS" "sr_Latn_ME" "sr_Latn_RS" "sv_FI" "sv_SE" "sw_KE" "ta_IN" "ta_LK" "te_IN" "tl_PH" "tn_BW" "tn_ZA" "tr_TR" "tt_RU" "uk_UA" "ur_IN" "ur_PK" "uz_Latn_UZ" "vi_VN" "wo_SN" "xh_ZA" "yo_NG" "zh_CN" "zh_Latn_CN_x_ext" "zu_ZA"
expirations[text] required	Array of strings
type required	string Enum: "essential" "personalisation" "marketing" "analytics" "basic" "unclassified"
platform	string
descriptions[language] required	Array of strings Items Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SY" "ar_TN" "ar_YE" "as_IN" "az_Latn_AZ" "be_BY" "bg_BG" "bn_BD" "bn_IN" "bs_Latn_BA" "ca_ES" "ca_ES_valencia" "cs_CZ" "cy_GB" "da_DK" "de_AT" "de_CH" "de_DE" "de_LI" "de_LU" "el_GR" "en_029" "en_AU" "en_BZ" "en_CA" "en_GB" "en_HK" "en_ID" "en_IE" "en_IN" "en_JM" "en_LR" "en_MY" "en_NZ" "en_PH" "en_SG" "en_TT" "en_US" "en_ZA" "en_ZW" "es_419" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_ES_tradnl" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "eu_ES" "fa_IR" "fi_FI" "fr_015" "fr_029" "fr_BE" "fr_CA" "fr_CD" "fr_CH" "fr_CI" "fr_CM" "fr_FR" "fr_HT" "fr_LU" "fr_MA" "fr_MC" "fr_ML" "fr_RE" "fr_SN" "ga_IE" "gd_GB" "gl_ES" "gu_IN" "ha_Latn_NG" "he_IL" "hi_IN" "hr_BA" "hr_HR" "hu_HU" "hy_AM" "id_ID" "ig_NG" "is_IS" "it_CH" "it_IT" "ja_JP" "ja_Latn_JP_x_ext" "ka_GE" "kk_KZ" "km_KH" "kn_IN" "kok_Deva_IN" "ky_KG" "lb_LU" "lt_LT" "lv_LV" "mi_NZ" "mk_MK" "ml_IN" "mr_IN" "ms_BN" "ms_MY" "mt_MT" "nb_NO" "ne_IN" "ne_NP" "nl_BE" "nl_NL" "nn_NO" "nso_ZA" "or_IN" "pa_IN" "pl_PL" "ps_AF" "pt_BR" "pt_PT" "rm_CH" "ro_MO" "ro_RO" "ru_MO" "ru_RU" "rw_RW" "si_LK" "sk_SK" "sl_SI" "sq_AL" "sr_Cyrl_BA" "sr_Cyrl_CS" "sr_Cyrl_ME" "sr_Cyrl_RS" "sr_Latn_BA" "sr_Latn_CS" "sr_Latn_ME" "sr_Latn_RS" "sv_FI" "sv_SE" "sw_KE" "ta_IN" "ta_LK" "te_IN" "tl_PH" "tn_BW" "tn_ZA" "tr_TR" "tt_RU" "uk_UA" "ur_IN" "ur_PK" "uz_Latn_UZ" "vi_VN" "wo_SN" "xh_ZA" "yo_NG" "zh_CN" "zh_Latn_CN_x_ext" "zu_ZA"
descriptions[text] required	Array of strings

Responses

Response samples

201
403
404

Content type

application/json

{"id": "string",
"name": "string",
"domain": "string",
"path": "string",
"platform": "string",
"expirations": {"language": "string",
"text": "string"
},
"type": "essential",
"source": "manual",
"descriptions": {"language": "string",
"text": "string"
}
}

getDomainsDomainIdCookieBannerCookies

List domain cookies

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"name": "string",
"domain": "string",
"path": "string",
"platform": "string",
"expirations": {"language": "string",
"text": "string"
},
"type": "essential",
"source": "manual",
"descriptions": {"language": "string",
"text": "string"
}
}

deleteDomainsDomainIdCookieBannerCookiesId

Delete a cookie

path Parameters

id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdCookieBannerCookiesId

Update a cookie

path Parameters

id required	integer <int32>
domain_id required	integer <int32>

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

name	string
domain	string
expirations[language] required	Array of strings Items Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SY" "ar_TN" "ar_YE" "as_IN" "az_Latn_AZ" "be_BY" "bg_BG" "bn_BD" "bn_IN" "bs_Latn_BA" "ca_ES" "ca_ES_valencia" "cs_CZ" "cy_GB" "da_DK" "de_AT" "de_CH" "de_DE" "de_LI" "de_LU" "el_GR" "en_029" "en_AU" "en_BZ" "en_CA" "en_GB" "en_HK" "en_ID" "en_IE" "en_IN" "en_JM" "en_LR" "en_MY" "en_NZ" "en_PH" "en_SG" "en_TT" "en_US" "en_ZA" "en_ZW" "es_419" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_ES_tradnl" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "eu_ES" "fa_IR" "fi_FI" "fr_015" "fr_029" "fr_BE" "fr_CA" "fr_CD" "fr_CH" "fr_CI" "fr_CM" "fr_FR" "fr_HT" "fr_LU" "fr_MA" "fr_MC" "fr_ML" "fr_RE" "fr_SN" "ga_IE" "gd_GB" "gl_ES" "gu_IN" "ha_Latn_NG" "he_IL" "hi_IN" "hr_BA" "hr_HR" "hu_HU" "hy_AM" "id_ID" "ig_NG" "is_IS" "it_CH" "it_IT" "ja_JP" "ja_Latn_JP_x_ext" "ka_GE" "kk_KZ" "km_KH" "kn_IN" "kok_Deva_IN" "ky_KG" "lb_LU" "lt_LT" "lv_LV" "mi_NZ" "mk_MK" "ml_IN" "mr_IN" "ms_BN" "ms_MY" "mt_MT" "nb_NO" "ne_IN" "ne_NP" "nl_BE" "nl_NL" "nn_NO" "nso_ZA" "or_IN" "pa_IN" "pl_PL" "ps_AF" "pt_BR" "pt_PT" "rm_CH" "ro_MO" "ro_RO" "ru_MO" "ru_RU" "rw_RW" "si_LK" "sk_SK" "sl_SI" "sq_AL" "sr_Cyrl_BA" "sr_Cyrl_CS" "sr_Cyrl_ME" "sr_Cyrl_RS" "sr_Latn_BA" "sr_Latn_CS" "sr_Latn_ME" "sr_Latn_RS" "sv_FI" "sv_SE" "sw_KE" "ta_IN" "ta_LK" "te_IN" "tl_PH" "tn_BW" "tn_ZA" "tr_TR" "tt_RU" "uk_UA" "ur_IN" "ur_PK" "uz_Latn_UZ" "vi_VN" "wo_SN" "xh_ZA" "yo_NG" "zh_CN" "zh_Latn_CN_x_ext" "zu_ZA"
expirations[text] required	Array of strings
type	string Enum: "essential" "personalisation" "marketing" "analytics" "basic" "unclassified"
platform	string
source	string Enum: "manual" "scanned" "scanned_now_absent"
descriptions[language] required	Array of strings Items Enum: "ar_AE" "ar_BH" "ar_DZ" "ar_EG" "ar_IQ" "ar_JO" "ar_KW" "ar_LB" "ar_LY" "ar_MA" "ar_OM" "ar_QA" "ar_SA" "ar_SY" "ar_TN" "ar_YE" "as_IN" "az_Latn_AZ" "be_BY" "bg_BG" "bn_BD" "bn_IN" "bs_Latn_BA" "ca_ES" "ca_ES_valencia" "cs_CZ" "cy_GB" "da_DK" "de_AT" "de_CH" "de_DE" "de_LI" "de_LU" "el_GR" "en_029" "en_AU" "en_BZ" "en_CA" "en_GB" "en_HK" "en_ID" "en_IE" "en_IN" "en_JM" "en_LR" "en_MY" "en_NZ" "en_PH" "en_SG" "en_TT" "en_US" "en_ZA" "en_ZW" "es_419" "es_AR" "es_BO" "es_CL" "es_CO" "es_CR" "es_DO" "es_EC" "es_ES" "es_ES_tradnl" "es_GT" "es_HN" "es_MX" "es_NI" "es_PA" "es_PE" "es_PR" "es_PY" "es_SV" "es_US" "es_UY" "es_VE" "et_EE" "eu_ES" "fa_IR" "fi_FI" "fr_015" "fr_029" "fr_BE" "fr_CA" "fr_CD" "fr_CH" "fr_CI" "fr_CM" "fr_FR" "fr_HT" "fr_LU" "fr_MA" "fr_MC" "fr_ML" "fr_RE" "fr_SN" "ga_IE" "gd_GB" "gl_ES" "gu_IN" "ha_Latn_NG" "he_IL" "hi_IN" "hr_BA" "hr_HR" "hu_HU" "hy_AM" "id_ID" "ig_NG" "is_IS" "it_CH" "it_IT" "ja_JP" "ja_Latn_JP_x_ext" "ka_GE" "kk_KZ" "km_KH" "kn_IN" "kok_Deva_IN" "ky_KG" "lb_LU" "lt_LT" "lv_LV" "mi_NZ" "mk_MK" "ml_IN" "mr_IN" "ms_BN" "ms_MY" "mt_MT" "nb_NO" "ne_IN" "ne_NP" "nl_BE" "nl_NL" "nn_NO" "nso_ZA" "or_IN" "pa_IN" "pl_PL" "ps_AF" "pt_BR" "pt_PT" "rm_CH" "ro_MO" "ro_RO" "ru_MO" "ru_RU" "rw_RW" "si_LK" "sk_SK" "sl_SI" "sq_AL" "sr_Cyrl_BA" "sr_Cyrl_CS" "sr_Cyrl_ME" "sr_Cyrl_RS" "sr_Latn_BA" "sr_Latn_CS" "sr_Latn_ME" "sr_Latn_RS" "sv_FI" "sv_SE" "sw_KE" "ta_IN" "ta_LK" "te_IN" "tl_PH" "tn_BW" "tn_ZA" "tr_TR" "tt_RU" "uk_UA" "ur_IN" "ur_PK" "uz_Latn_UZ" "vi_VN" "wo_SN" "xh_ZA" "yo_NG" "zh_CN" "zh_Latn_CN_x_ext" "zu_ZA"
descriptions[text] required	Array of strings

Responses

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"name": "string",
"domain": "string",
"path": "string",
"platform": "string",
"expirations": {"language": "string",
"text": "string"
},
"type": "essential",
"source": "manual",
"descriptions": {"language": "string",
"text": "string"
}
}

getDomainsDomainIdCookieBannerConsents

List consents

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date>
to	string <date>
tc_string	string
user_agent	string
country_code	string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
anon_ip	string
session_id	string
sort_by	string Default: "timestamp" Value: "timestamp"
sort_dir	string Default: "asc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"timestamp": "string",
"page_url": "string",
"user_agent": "string",
"country_code": "string",
"anon_ip": "string",
"tc_string": "string",
"session_id": "string"
}

getDomainsDomainIdCookieBannerStatistics

List consents

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date>
to	string <date>

Responses

Response samples

200
403

Content type

application/json

{"daily_total_counts": {"day": "string",
"count": "string"
},
"daily_consent_counts": {"day": "string",
"consent": "string",
"count": "string"
},
"total_count": "string"
}

postDomainsDomainIdHeatmapsRules

create a heatmap rule

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

heatmap_type	Array of strings Items Enum: "click" "scroll" "movement"
page_id required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"heatmap_type": ["click"
],
"page_id": 0
}

Response samples

201
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"page_id": "string",
"heatmap_type": "string",
"page": {"id": "string",
"url": "string",
"title": "string"
},
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdHeatmapsRules

List heatmaps_rules rules for domain

path Parameters

domain_id

required

integer <int32>

query Parameters

heatmap_type	Array of strings Items Enum: "click" "scroll" "movement"
page_id	string
sort_by	string Default: "created_at" Value: "created_at"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"domain_id": "string",
"page_id": "string",
"heatmap_type": "string",
"page": {"id": "string",
"url": "string",
"title": "string"
},
"created_at": "string",
"updated_at": "string"
}

deleteDomainsDomainIdHeatmapsRulesId

delete a heatmap rule

path Parameters

id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdHeatmapsRulesId

Update a heatmaps rule

path Parameters

id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

Array

string

Default: ["click","scroll","movement"]

Enum: "click" "scroll" "movement"

Responses

Request samples

Payload

Content type

application/json

["click"
]

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"page_id": "string",
"heatmap_type": "string",
"page": {"id": "string",
"url": "string",
"title": "string"
},
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdHeatmaps

List heatmaps for domain

path Parameters

domain_id

required

integer <int32>

query Parameters

url	string
from	string <date>
to	string <date>
browser	string
os	string
device	string
sort_by	string Default: "session_ts" Value: "session_ts"
sort_dir	string Default: "asc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"browser": "string",
"os": "string",
"device": "string",
"url": "string",
"timestamp": "string",
"data": "string"
}

getDomainsDomainIdPageLinks

List page-links

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string Search in orig_url, title_alt and text (% as wildcard)
sort_by	string Default: "orig_url" Enum: "orig_url" "title_alt" "text"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPageLinksPageLinkId

Get page-link

path Parameters

page_link_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPoliciesPages

List pages with policy matches

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
mode	string Enum: "search" "violation" "required"

Responses

Response samples

200
403
404

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
}

getDomainsDomainIdPolicies

List Policies

path Parameters

domain_id

required

integer <int32>

query Parameters

labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_by	string Default: "matches_count" Enum: "name" "matches_count" "pages_count" "links_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
mode	string Enum: "search" "violation" "required"
search	string
scheduled	boolean
tags	Array of strings
js_regex	boolean Default: false

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

created_by

Array of integers <int32> [ items <int32 > ]

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPoliciesIgnoredPoliciesPages

List pages with ignored policies

path Parameters

domain_id

required

integer <int32>

query Parameters

labels	Array of integers <int32> [ items <int32 > ]
sort_dir	string Default: "desc" Enum: "asc" "desc"
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
search	string
sort_by	string Default: "ignored_policies_count" Enum: "title" "ignored_policies_count"

Responses

Response samples

200
403
404

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,
"ignored_policies_count": "string"
}

getDomainsDomainIdPoliciesPolicyIdLinks

List policy links

path Parameters

policy_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

status	string Enum: "active" "dead" "ignored" "fixed"
sort_by	string Default: "url" Enum: "url" "text" "html_pages_count" "dead_on_pages_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
type	string Enum: "not_image" "image" "documents" "link" "anchor" "email" "javascript" "irc" "unknown" "file" "iframe" "frame" "form" "area" "script" "headlink" "source" "embed" "object" "spreadsheet" "document" "pdf" "css" "js" "archive" "slide" "tel" "quote" "audio" "video" "track" "portal" "inline_image" `javascript` is inline javascript and `js` is javascript files. document is text documents and documents is all documents
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
search	string URL search

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPoliciesPolicyIdPages

List policy pages

path Parameters

policy_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
mode	string Enum: "search" "violation" "required"
status	string Default: "active" Enum: "active" "ignored" "all" Filter policy matches by status

Responses

Response samples

200
403
404

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
}

getDomainsDomainIdPoliciesPolicyId

Get policy

path Parameters

policy_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

js_regex

boolean

Default: false

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdDataProtectionContents

Get a list of data protection contents for domain

path Parameters

domain_id

required

integer <int32>

query Parameters

sort_by	string Default: "id" Enum: "id" "effect_on_compliance"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"content": "string",
"effect_on_compliance": "string",
"pages_affected": "string",
"created_at": "string"
}

getDomainsDomainIdDataProtectionCustomRuleset

List enabled info types for domain with Data Protection

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string
sort_by	string Default: "identifier" Enum: "created_at" "identifier" "priority"
priority	string
regulations	Array of strings Items Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA"
regions	Array of strings Items Enum: "global" "argentina" "australia" "belgium" "brazil" "canada" "chile" "china" "colombia" "denmark" "finland" "france" "germany" "hong_kong" "india" "indonesia" "ireland" "israel" "italy" "japan" "korea" "mexico" "norway" "paraguay" "peru" "poland" "portugal" "singapore" "spain" "sweden" "taiwan" "thailand" "the_netherlands" "turkey" "united_kingdom" "united_states" "uruguay" "venezuela"
group	Array of strings Items Enum: "banking_data" "driving_permit" "general_personal_data" "healthcare" "national_id" "other" "sensitive_personal_data" "taxpayer_id" "technical" "product_identifier" "personal_technical"
compliant	boolean
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
}

getDomainsDomainIdDataProtectionFastTrack

Get Data Protection Fast Tracked contents

path Parameters

domain_id

required

integer <int32>

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"content": "string",
"effect_on_compliance": "string",
"pages_affected": "string",
"fast_track_info_types": {"id": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}
},
"created_at": "string"
}

getDomainsDomainIdDataProtectionFastTrackDataProtectionContentIdViolations

Get data protection violations for a content

path Parameters

data_protection_content_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
}
}

getDomainsDomainIdDataProtectionFastTrackDataProtectionContentId

Get data protection content

path Parameters

data_protection_content_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"content": "string",
"effect_on_compliance": "string",
"pages_affected": "string",
"fast_track_info_types": {"id": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}
},
"created_at": "string"
}

getDomainsDomainIdDataProtectionFastTrackDataProtectionContentIdInfoTypes

get info types for a content

path Parameters

domain_id required	integer <int32>
data_protection_content_id required	integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"pages_count": "string"
}

patchDomainsDomainIdDataProtectionFastTrackDataProtectionContentIdInfoTypesInfoTypeId

ignore a data protection info type for a content

path Parameters

info_type_id required	integer <int32>
domain_id required	integer <int32>
data_protection_content_id required	integer <int32>

Request Body schema: application/json

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

200
403

Content type

application/json

{"id": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}
}

getDomainsDomainIdDataProtectionInfoTypes

get info types for a content

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"pages_count": "string"
}

patchDomainsDomainIdDataProtectionInfoTypesInfoTypeId

ignore a data protection info type for a content

path Parameters

info_type_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Response samples

200
403

Content type

application/json

{"id": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}
}

getDomainsDomainIdDataProtectionSummary

Summary of violations on the domain

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"pages_with_data_protection_violations_count": 0,
"pages_without_data_protection_violations_count": 0,
"violations_total_count": 0,
"violations_active_counts": { },
"violations_ignored_counts": { },
"violations_fixed_counts": { },
"page_violation_total_count": 0,
"page_violation_active_counts": { },
"page_violation_ignored_counts": { },
"page_violation_fixed_counts": { },
"compliance_percentage": 0
}

getDomainsDomainIdDataProtectionViolations

Get a list of data protection violations for domain

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string
priority	string Enum: "low" "medium" "high"
status	string Enum: "active" "auto_ignored" "ignored" "fixed"
info_type	integer <int32>
identifier	string
sort_by	string Default: "identifier" Enum: "page_count" "identifier" "name" "priority" "group" "status" "likelihood" "regulation" "region"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

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

regulations	Array of strings Items Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA"
group	Array of strings Items Enum: "banking_data" "driving_permit" "general_personal_data" "healthcare" "national_id" "other" "sensitive_personal_data" "taxpayer_id" "technical" "product_identifier" "personal_technical"
regions	Array of strings Items Enum: "global" "argentina" "australia" "belgium" "brazil" "canada" "chile" "china" "colombia" "denmark" "finland" "france" "germany" "hong_kong" "india" "indonesia" "ireland" "israel" "italy" "japan" "korea" "mexico" "norway" "paraguay" "peru" "poland" "portugal" "singapore" "spain" "sweden" "taiwan" "thailand" "the_netherlands" "turkey" "united_kingdom" "united_states" "uruguay" "venezuela"

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
}
}

patchDomainsDomainIdDataProtectionViolationsViolationId

Ignore a data protection violation for this domain

path Parameters

violation_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

status

string

Default: "ignored"

Mark a violation as ignored/fixed/active

Responses

Request samples

Payload

Content type

application/json

{"status": "ignored"
}

Response samples

200
403

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
}
}

deleteDomainsDomainIdCrawlsRunning

Stop crawl

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getDomainsDomainIdCrawlsRunning

Get the currently running scan

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"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
}

postDomainsDomainIdCrawls

Start crawl

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

201
403
404

Content type

application/json

{"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
}

getDomainsDomainIdCrawls

List crawls

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date>
to	string <date>
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"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
}

postDomainsDomainIdDomainGroupsUpdate

Update all groups rules

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

postDomainsDomainIdDomainGroups

Create group

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

title required	string
description	string
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"rules": [{"match": "url",
"match_rule": "regexp",
"exclude": true,
"key": "string",
"label_ids": [0
],
"text": "string"
}
],
"domain_group_members": [{"visible": true,
"send_report": true,
"user_id": 0,
"id": 0
}
]
}

Response samples

201
400
403

Content type

application/json

{"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": { }
}

getDomainsDomainIdDomainGroups

List groups

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string Title search
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "title" Enum: "id" "title"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"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": { }
}

getDomainsDomainIdDomainGroupsGroupIdHistory

Get domain group history

path Parameters

group_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

from	string <date>
to	string <date>
page	integer <int32> Default: 1
page_size	integer <int32> Default: 6
sort_by	string Default: "date" Value: "date"
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"date": "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_issues": "string",
"accessibility_checks": "string",
"accessiblity_issues_count": "string",
"accessibility_reviewed_documents": "string",
"accessibility_pages_by_result_type_and_abbr": "string",
"accessibility_checks_by_result_type_and_abbr": "string",
"accessibility_guideline_id": "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",
"data_protection_pages_with_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",
"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
}

deleteDomainsDomainIdDomainGroupsGroupId

Delete group

path Parameters

group_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdDomainGroupsGroupId

Update domain

path Parameters

group_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

title	string
description	string
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"rules": [{"match": "url",
"match_rule": "regexp",
"exclude": true,
"key": "string",
"label_ids": [0
],
"text": "string"
}
],
"domain_group_members": [{"visible": true,
"send_report": true,
"user_id": 0,
"id": 0
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"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": { }
}

getDomainsDomainIdDomainGroupsGroupId

Get group

path Parameters

group_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"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": { }
}

getDomainsDomainIdInventorySummary

Get a Summary for the inventory module

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"type": "string",
"count": 0
}

getDomainsDomainIdLinks

List links

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string
relation	string Enum: "internal" "external" Link relation
status	string Enum: "active" "dead" "ignored" "fixed"
sort_by	string Default: "url" Enum: "url" "text" "html_pages_count" "dead_on_pages_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
type	string Enum: "not_image" "image" "documents" "link" "anchor" "email" "javascript" "irc" "unknown" "file" "iframe" "frame" "form" "area" "script" "headlink" "source" "embed" "object" "spreadsheet" "document" "pdf" "css" "js" "archive" "slide" "tel" "quote" "audio" "video" "track" "portal" "inline_image" `javascript` is inline javascript and `js` is javascript files. document is text documents and documents is all documents
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
page_fixed	boolean
accessibility_reviewed	boolean
page_type	string Enum: "html" "document" Filter on page_type
status_code	integer <int32> Filter based on the link status code. Accepts 1xx-5xx or "0", for links without a code.
labels	Array of integers <int32> [ items <int32 > ]

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdLinksLinkIdOriginalUrls

List original urls for link

path Parameters

link_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"url": "string"
}

getDomainsDomainIdLinksLinkIdPages

List pages with link

path Parameters

link_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

200
403
404

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
}

getDomainsDomainIdLinksLinkIdPageLinks

List page-links for a link

path Parameters

link_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

search	string
status_code	integer <int32>
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"page": {"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
}
}

patchDomainsDomainIdLinksLinkId

Patch link

path Parameters

link_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

status	string Enum: "dead" "ignored" "hidden" "fixed"
accessibility_reviewed	boolean
labels	Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"status": "dead",
"accessibility_reviewed": true,
"labels": [0
]
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdLinksLinkId

Get link

path Parameters

link_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdNiNumbersPages

List pages with one or more ni_numbers

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

200
403

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
}

getDomainsDomainIdNiNumbers

List National Identity numbers

path Parameters

domain_id

required

integer <int32>

query Parameters

priority	string Enum: "potential" "unlikely" "confirmed"
status	string Enum: "active" "ignored" "fixed"
search	string
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"domain_id": "string",
"location": "string",
"value": "string",
"status": "string",
"groups": "string",
"page_count": "string",
"document_count": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

patchDomainsDomainIdNiNumbersNiNumberId

change a ni_numbers status

path Parameters

ni_number_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

status

string

Enum: "active" "ignored" "fixed"

active, fixed or ignored

Responses

Request samples

Payload

Content type

application/json

{"status": "active"
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"domain_id": "string",
"location": "string",
"value": "string",
"status": "string",
"groups": "string",
"page_count": "string",
"document_count": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdNiNumbersNiNumberIdPages

List pages for a single ni_number

path Parameters

ni_number_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
priority	string Enum: "potential" "unlikely" "confirmed"
status	string Enum: "active" "ignored" "fixed"

Responses

Response samples

200
403

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
}

getDomainsDomainIdPages

List pages

path Parameters

domain_id

required

integer <int32>

query Parameters

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
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
title	string Only pages with this title
mini	boolean Default: false Only return basic information for each
has_performance	boolean Filter pages that either are or aren't part of the performance module

Responses

Response samples

200
403

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
}

getDomainsDomainIdPagesPageIdIncoming

List other pages with link to page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

all	boolean Default: false
search	string
type	string Enum: "html" "pdf" "document" Filter on type
types	Array of strings Items Enum: "html" "pdf" "document" Filter on multiple types
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

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,
"orig_url": "string",
"text": "string",
"title_alt": "string"
}

patchDomainsDomainIdPagesPageId

Update a page

path Parameters

page_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

labels	Array of integers <int32> [ items <int32 > ]
language	string Language override

Responses

Request samples

Payload

Content type

application/json

{"labels": [0
],
"language": "string"
}

Response samples

200
403
404

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
}

getDomainsDomainIdPagesPageId

Get page

path Parameters

page_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

mini	boolean Default: false Only return basic information

Responses

Response samples

200
403
404

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
}

getDomainsDomainIdPagesPageIdMetadata

Get meta data for a page

path Parameters

page_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

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
type	string Enum: "meta" "header" Filter on type
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"page_id": "string",
"type": "string",
"key": "string",
"value": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdClarityChecks

Get Clarity checks on a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"name": "string",
"errors_count": "string"
}

getDomainsDomainIdPagesPageIdClarityChecksClarityAccessibilityCheckIdErrors

Get Clarity accessibility errors on a pdf for a check

path Parameters

clarity_accessibility_check_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

result_type	string Enum: "error" "warning" "review"
ignored_reviewed	boolean
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"result_type": "string",
"ignored_reviewed": "string",
"clarity_accessibility_check_id": "string",
"page_id": "string",
"page_number": "string",
"element_tree_path": "string",
"reason": "string",
"clarity_comments": "string",
"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"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"latest_check_at": "2019-08-24T14:15:22Z"
}

patchDomainsDomainIdPagesPageIdClarityChecksClarityAccessibilityCheckIdErrorsClarityAccessibilityErrorId

update a Clarity accessibility error for this pdf

path Parameters

clarity_accessibility_check_id required	integer <int32>
clarity_accessibility_error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

ignored_reviewed required	boolean
comment	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
403
404

Content type

application/json

{"id": "string",
"result_type": "string",
"ignored_reviewed": "string",
"clarity_accessibility_check_id": "string",
"page_id": "string",
"page_number": "string",
"element_tree_path": "string",
"reason": "string",
"clarity_comments": "string",
"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"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"latest_check_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdAccessibilitySummary

Get accessibility summary

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"508": 0,
"total_issues": 0,
"A": 0,
"AA": 0,
"AAA": 0
}

getDomainsDomainIdPagesPageIdAccessibilityErrors

Get accessibility errors

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

responsibility	string Enum: "Visual Design" "UX Design" "Content Authoring" "Front-end Development"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"check_id": 0,
"type": "string",
"source_code_id": 0,
"source_code": 0,
"sequence_no": 0,
"ignored": true,
"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"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteDomainsDomainIdPagesPageIdAccessibilityErrorsAccessibilityErrorId

Mark an accessibility error fixed for this page

path Parameters

accessibility_error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

comment

string

Responses

Response samples

403

Content type

application/json

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

patchDomainsDomainIdPagesPageIdAccessibilityErrorsAccessibilityErrorId

update an accessibility error for this page

path Parameters

accessibility_error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

status	boolean Deprecated: use ignored_reviewed instead
ignored_reviewed	boolean
comment	string

Responses

Request samples

Payload

Content type

application/json

{"status": true,
"ignored_reviewed": true,
"comment": "string"
}

Response samples

200
403

Content type

application/json

{"id": 0,
"check_id": 0,
"type": "string",
"source_code_id": 0,
"source_code": 0,
"sequence_no": 0,
"ignored": true,
"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"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdAccessibilityErrorsAccessibilityErrorId

show an accessibility error for this page

path Parameters

accessibility_error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"check_id": 0,
"type": "string",
"source_code_id": 0,
"source_code": 0,
"sequence_no": 0,
"ignored": true,
"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"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdAccessibilityChecks

Get accessibility checks on page

path Parameters

domain_id required	integer <int32>
page_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"

Responses

Response samples

200
403

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,
"ignored_on_page": "string"
}

deleteDomainsDomainIdPagesPageIdAccessibilityChecksAccessibilityCheckIdErrors

Mark accessibility errors fixed on page for check

path Parameters

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

query Parameters

comment

string

Responses

Response samples

403

Content type

application/json

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

patchDomainsDomainIdPagesPageIdAccessibilityChecksAccessibilityCheckIdErrors

Update accessibility errors on page for check

path Parameters

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

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

ignored_reviewed required	boolean
comment	string

Responses

Response samples

403

Content type

application/json

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

getDomainsDomainIdPagesPageIdAccessibilityChecksAccessibilityCheckIdErrors

Get accessibility errors on page for check

path Parameters

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

query Parameters

type	string Enum: "error" "warning" "review"
status	string Enum: "active" "ignored"
responsibility	string Enum: "Visual Design" "UX Design" "Content Authoring" "Front-end Development"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"check_id": 0,
"type": "string",
"source_code_id": 0,
"source_code": 0,
"sequence_no": 0,
"ignored": true,
"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"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

patchDomainsDomainIdPagesPageIdAccessibilityChecksAccessibilityCheckId

Ignore a accessibility check for page

path Parameters

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

Request Body schema: application/json

type required	string Enum: "check" "errors" 'check' will (un)ignore the check (and delete all errors if ignored). 'errors' will (un)ignore all the errors
ignored	boolean Default: true true will ignore the errors/check, false will unignore
comment	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
403

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"
}
}

getDomainsDomainIdPagesPageIdNiNumbers

List ni numbers for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

status	string Enum: "active" "ignored" "fixed"
priority	string Enum: "potential" "unlikely" "confirmed"
search	string
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"page_id": "string",
"ni_number_id": "string",
"status": "string",
"priority": "string",
"ni_number": {"id": "string",
"domain_id": "string",
"location": "string",
"value": "string",
"status": "string",
"groups": "string",
"page_count": "string",
"document_count": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

patchDomainsDomainIdPagesPageIdNiNumbersNiNumberId

Update a page_ni_number

path Parameters

ni_number_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

status

required

string

Enum: "active" "ignored" "fixed"

Responses

Request samples

Payload

Content type

application/json

{"status": "active"
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"page_id": "string",
"ni_number_id": "string",
"status": "string",
"priority": "string",
"ni_number": {"id": "string",
"domain_id": "string",
"location": "string",
"value": "string",
"status": "string",
"groups": "string",
"page_count": "string",
"document_count": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdPageLinks

List page links

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

status	string Enum: "active" "dead" "ignored" "fixed"
search	string
type	string Enum: "not_image" "image" "link" "anchor" "email" "javascript" "irc" "unknown" "file" "iframe" "frame" "form" "area" "script" "headlink" "source" "embed" "object" "spreadsheet" "document" "pdf" "css" "js" "archive" "slide" "tel" "quote" "audio" "video" "track" "portal" "inline_image"
status_code	integer <int32>
page_fixed	boolean
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"link": {"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

patchDomainsDomainIdPagesPageIdPageLinksPageLinkId

Update page-link

path Parameters

page_link_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

status

required

string

Enum: "dead" "ignored" "fixed"

Responses

Request samples

Payload

Content type

application/json

{"status": "dead"
}

Response samples

200
403
404

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"link": {"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdPagesPageIdPageLinksPageLinkId

Get page-link

path Parameters

page_link_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"page_id": 0,
"link_id": 0,
"status": "string",
"text": "string",
"title_alt": "string",
"orig_url": "string",
"no_follow": true,
"rel": "string",
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"link": {"id": "string",
"domain_id": "string",
"url": "string",
"mime_type": "string",
"type": "string",
"status": "string",
"relation": "string",
"redirect": "string",
"status_code": "string",
"accessibility_reviewed": "string",
"html_pages_count": "string",
"documents_count": "string",
"dead_on_pages_count": "string",
"dead_on_documents_count": "string",
"ignored_on_pages_count": "string",
"ignored_on_documents_count": "string",
"fixed_on_pages_count": "string",
"fixed_on_documents_count": "string",
"groups": "string",
"content_length": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"lastcheck": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdPagesPageIdPolicies

List policies for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

mode	string Enum: "search" "violation" "required"
ignored	boolean
scheduled	boolean
search	string
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"ignored": true,
"matches": [{"name": "string",
"type": "string",
"matches": ["string"
]
}
]
}

deleteDomainsDomainIdPagesPageIdPoliciesPolicyId

Delete policy match on page (Mark fixed)

path Parameters

policy_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdPagesPageIdPoliciesPolicyId

Update policy ignored state on page

path Parameters

policy_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

ignored

required

boolean

Responses

Request samples

Payload

Content type

application/json

{"ignored": true
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"ignored": true,
"matches": [{"name": "string",
"type": "string",
"matches": ["string"
]
}
]
}

getDomainsDomainIdPagesPageIdSeoIssues

List SEO issues for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"issues": [{"id": "string",
"content": "string",
"marked_as_fixed_at": "2019-08-24T14:15:22Z",
"ignored_at": "2019-08-24T14:15:22Z"
}
],
"translation_name": "string",
"classification": "string",
"ignored": "string"
}

getDomainsDomainIdPagesPageIdSeoIssuesSeoIssueIdContent

Get content for seo issue (like the images without alt or the page title)

path Parameters

seo_issue_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdPagesPageIdSeoIssuesSeoIssueId

Update (ignore/mark as fixed) a page_seo_issue

path Parameters

seo_issue_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

status

required

string

Enum: "fixed" "ignored" "active"

Responses

Request samples

Payload

Content type

application/json

{"status": "fixed"
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"content": "string",
"marked_as_fixed_at": "2019-08-24T14:15:22Z",
"ignored_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdPagesPageIdSpellingErrors

Get a list of spelling errors for this page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

search	string
language	string
sort_by	string Enum: "word" "html_pages_count" "documents_count"
classification	string Enum: "potential" "confirmed"
page_fixed	boolean
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"domain_id": "string",
"language": "string",
"html_pages_count": "string",
"documents_count": "string",
"classification": "string",
"groups": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

postDomainsDomainIdPagesPageIdSpellingErrorsErrorIdIgnore

Ignore a spelling error for this page

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

201
403
404

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteDomainsDomainIdPagesPageIdSpellingErrorsErrorId

Mark spelling error fixed on this page

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getDomainsDomainIdPagesPageIdSpellingErrorsErrorId

Get spelling error

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getDomainsDomainIdPagesPageIdIgnoredSpellingErrors

Get a list of ignored misspellings for this page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

search	string
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteDomainsDomainIdPagesPageIdIgnoredSpellingErrorsSpellingIgnoredId

Delete ignored misspelling

path Parameters

spelling_ignored_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getDomainsDomainIdPagesPageIdStatisticsSummary

Get a statistics summary for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403
404

Content type

application/json

{"date": "string",
"visits": "string",
"visitors": 0,
"avg_time": "string",
"bounce_rate": "string",
"avg_actions": "string",
"pageviews": "string",
"uniq_pageviews": 0,
"bounce_count": 0
}

getDomainsDomainIdPagesPageIdStatisticsVisitors

Get a list of visitors (by date) for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

type	string Default: "total" Enum: "total" "direct" "organic" "paid" "referring" "social"
from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403
404

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdPagesPageIdContent

Get content for a page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

pretty_print

boolean

Responses

Response samples

200
403
404

Content type

application/json

{"content": "string"
}

getDomainsDomainIdPagesPageIdRescan

Get the latest scan request for this page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"status": "string",
"failure_reason": "string",
"created_at": "string"
}

postDomainsDomainIdPagesPageIdRescan

Request a scan of the page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

400
403

Content type

application/json

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

getDomainsDomainIdPagesPageIdDataProtectionViolations

Get a list of data protection violations for this page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

search	string
priority	string Enum: "low" "medium" "high"
status	string Enum: "active" "auto_ignored" "ignored" "fixed"
info_type	integer <int32>
identifier	string
sort_by	string Default: "identifier" Enum: "page_count" "identifier" "name" "priority" "group" "status" "likelihood" "regulation" "region"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

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

regulations	Array of strings Items Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA"
group	Array of strings Items Enum: "banking_data" "driving_permit" "general_personal_data" "healthcare" "national_id" "other" "sensitive_personal_data" "taxpayer_id" "technical" "product_identifier" "personal_technical"
regions	Array of strings Items Enum: "global" "argentina" "australia" "belgium" "brazil" "canada" "chile" "china" "colombia" "denmark" "finland" "france" "germany" "hong_kong" "india" "indonesia" "ireland" "israel" "italy" "japan" "korea" "mexico" "norway" "paraguay" "peru" "poland" "portugal" "singapore" "spain" "sweden" "taiwan" "thailand" "the_netherlands" "turkey" "united_kingdom" "united_states" "uruguay" "venezuela"

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
},
"status": "string",
"occurrences": 0
}

patchDomainsDomainIdPagesPageIdDataProtectionViolationsViolationId

Ignore a data_protection violation for this page

path Parameters

violation_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Request Body schema: application/json

status

string

Default: "ignored"

Mark a DataProtection::PageViolation as ignored/fixed/active

Responses

Request samples

Payload

Content type

application/json

{"status": "ignored"
}

Response samples

200
403

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
},
"status": "string",
"occurrences": 0
}

getDomainsDomainIdPagesPageIdDataProtectionViolationsViolationId

Show a data_protection violation for this page

path Parameters

violation_id required	integer <int32>
domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"data_protection_content_id": 0,
"content": "string",
"likelihood": "string",
"page_count": 0,
"info_type": {"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true,
"info_type_domain_summary": {"id": 0,
"source_id": 0,
"source_type": "string",
"data_protection_violations_count": 0,
"pages_with_active_violations_count": 0,
"pages_with_ignored_violations_count": 0,
"pages_with_fixed_violations_count": 0,
"pages_without_active_violations_count": 0
}
},
"status": "string",
"occurrences": 0
}

getDomainsDomainIdPagesPageIdDataProtectionCustomRuleset

Get a list of info types with violations for this page

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

query Parameters

search	string
sort_by	string Default: "identifier" Enum: "created_at" "identifier" "priority"
priority	string
regulations	Array of strings Items Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA"
regions	Array of strings Items Enum: "global" "argentina" "australia" "belgium" "brazil" "canada" "chile" "china" "colombia" "denmark" "finland" "france" "germany" "hong_kong" "india" "indonesia" "ireland" "israel" "italy" "japan" "korea" "mexico" "norway" "paraguay" "peru" "poland" "portugal" "singapore" "spain" "sweden" "taiwan" "thailand" "the_netherlands" "turkey" "united_kingdom" "united_states" "uruguay" "venezuela"
group	Array of strings Items Enum: "banking_data" "driving_permit" "general_personal_data" "healthcare" "national_id" "other" "sensitive_personal_data" "taxpayer_id" "technical" "product_identifier" "personal_technical"
compliant	boolean
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}

getDomainsDomainIdPagesPageIdCmsUrl

Get the CMS url generated for the chosen CMS

path Parameters

domain_id required	integer <int32>
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"cms_url": "string"
}

getDomainsDomainIdReadabilityPages

Pages with readability level

path Parameters

domain_id

required

integer <int32>

query Parameters

readability_level required	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"
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

200
403
404

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
}

getDomainsDomainIdReadability

Readability summary

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

Responses

Response samples

200
403
404

Content type

application/json

{"test": "string",
"distribution": { }
}

postDomainsDomainIdUptimes

Create uptime

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

url required	string
status	boolean Default: true
pingtime	integer <int32> Default: 300
pingtime_on_error	integer <int32> Default: 300
pingtime_ammount	integer <int32> Default: 5
pingtime_requests	integer <int32> Default: 3
answertime	integer <int32> Default: 10000
answertime_requests	integer <int32> Default: 5
notification_fail	boolean Default: false
notification_long	boolean Default: false
email_long required	string
email_fail required	string
notification_fail_end	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"status": true,
"pingtime": 300,
"pingtime_on_error": 300,
"pingtime_ammount": 5,
"pingtime_requests": 3,
"answertime": 10000,
"answertime_requests": 5,
"notification_fail": false,
"notification_long": false,
"email_long": "string",
"email_fail": "string",
"notification_fail_end": false
}

Response samples

201
400
403

Content type

application/json

{"id": 0,
"url": "string",
"domain_id": 0,
"pingtime": 0,
"pingtime_on_error": 0,
"pingtime_requests": 0,
"answertime": 0,
"answertime_requests": 0,
"notification_fail": true,
"notification_long": true,
"notification_fail_end": true,
"email_fail": "string",
"email_long": "string",
"status": true,
"type": "string",
"last_result": true,
"last_check_at": "string",
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdUptimes

List Uptimes

path Parameters

domain_id

required

integer <int32>

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"url": "string",
"domain_id": 0,
"pingtime": 0,
"pingtime_on_error": 0,
"pingtime_requests": 0,
"answertime": 0,
"answertime_requests": 0,
"notification_fail": true,
"notification_long": true,
"notification_fail_end": true,
"email_fail": "string",
"email_long": "string",
"status": true,
"type": "string",
"last_result": true,
"last_check_at": "string",
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdUptimesUptimeIdReport

Uptime report

path Parameters

uptime_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

start_date required	string <date-time>
end_date required	string <date-time>

Responses

Response samples

200
403
404

Content type

application/json

{"downtimes_count": 0,
"avg_response_time": 0,
"last_result": true,
"success_rate": 0,
"data": [{"timestamp": 0,
"avg": 0
}
]
}

deleteDomainsDomainIdUptimesUptimeId

Delete uptime

path Parameters

uptime_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdUptimesUptimeId

Update uptime

path Parameters

uptime_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

url	string
status	boolean
pingtime	integer <int32>
pingtime_on_error	integer <int32>
pingtime_ammount	integer <int32>
pingtime_requests	integer <int32>
answertime	integer <int32>
answertime_requests	integer <int32>
notification_fail	boolean
notification_long	boolean
email_long required	string
email_fail required	string
notification_fail_end	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"status": true,
"pingtime": 0,
"pingtime_on_error": 0,
"pingtime_ammount": 0,
"pingtime_requests": 0,
"answertime": 0,
"answertime_requests": 0,
"notification_fail": true,
"notification_long": true,
"email_long": "string",
"email_fail": "string",
"notification_fail_end": false
}

Response samples

200
400
403
404

Content type

application/json

{"id": 0,
"url": "string",
"domain_id": 0,
"pingtime": 0,
"pingtime_on_error": 0,
"pingtime_requests": 0,
"answertime": 0,
"answertime_requests": 0,
"notification_fail": true,
"notification_long": true,
"notification_fail_end": true,
"email_fail": "string",
"email_long": "string",
"status": true,
"type": "string",
"last_result": true,
"last_check_at": "string",
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdUptimesUptimeId

Get uptime

path Parameters

uptime_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"url": "string",
"domain_id": 0,
"pingtime": 0,
"pingtime_on_error": 0,
"pingtime_requests": 0,
"answertime": 0,
"answertime_requests": 0,
"notification_fail": true,
"notification_long": true,
"notification_fail_end": true,
"email_fail": "string",
"email_long": "string",
"status": true,
"type": "string",
"last_result": true,
"last_check_at": "string",
"created_at": "string",
"updated_at": "string"
}

getDomainsDomainIdUptimesUptimeIdLogs

List Uptime logs

path Parameters

domain_id required	integer <int32>
uptime_id required	integer <int32>

query Parameters

start_date required	string <date-time>
end_date required	string <date-time>

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"uptime_id": 0,
"url": "string",
"result": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"timestamp": "2019-08-24T14:15:22Z",
"result_code": 0,
"time": 0
}

getDomainsDomainIdUptimesUptimeIdDowntimes

List Uptime downtimes

path Parameters

domain_id required	integer <int32>
uptime_id required	integer <int32>

query Parameters

start_date required	string <date-time>
end_date required	string <date-time>
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"uptime_id": 0,
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

postDomainsDomainIdUptimesUptimeIdScheduledDowntimes

Create scheduled downtime

path Parameters

domain_id required	integer <int32>
uptime_id required	integer <int32>

Request Body schema: application/json

recurring required	string Enum: "no" "daily" "weekly" "monthly"
description required	string Schedule description
start_at required	string <date-time> Schedule start time
end_at required	string <date-time> Schedule end time
register_downtime	boolean Default: false Still register downtime and hence affect availability percent

Responses

Request samples

Payload

Content type

application/json

{"recurring": "no",
"description": "string",
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"register_downtime": false
}

Response samples

201
400
403
404

Content type

application/json

{"id": 0,
"uptime_id": 0,
"recurring": "string",
"description": "string",
"register_downtime": true,
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"current_start_at": "2019-08-24T14:15:22Z",
"current_end_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdUptimesUptimeIdScheduledDowntimes

List Scheduled downtimes

path Parameters

domain_id required	integer <int32>
uptime_id required	integer <int32>

query Parameters

after_date	string <date> Only return scheduled uptimes starting after date
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"uptime_id": 0,
"recurring": "string",
"description": "string",
"register_downtime": true,
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"current_start_at": "2019-08-24T14:15:22Z",
"current_end_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteDomainsDomainIdUptimesUptimeIdScheduledDowntimesScheduledDowntimeId

Delete scheduled downtime

path Parameters

scheduled_downtime_id required	integer <int32>
domain_id required	integer <int32>
uptime_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdUptimesUptimeIdScheduledDowntimesScheduledDowntimeId

Create scheduled downtime

path Parameters

scheduled_downtime_id required	integer <int32>
domain_id required	integer <int32>
uptime_id required	integer <int32>

Request Body schema: application/json

recurring	string Enum: "no" "daily" "weekly" "monthly"
description	string Schedule description
start_at	string <date-time> Schedule start time
end_at	string <date-time> Schedule end time
register_downtime	boolean Default: false Still register downtime and hence affect availability percent

Responses

Request samples

Payload

Content type

application/json

{"recurring": "no",
"description": "string",
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"register_downtime": false
}

Response samples

200
400
403
404

Content type

application/json

{"id": 0,
"uptime_id": 0,
"recurring": "string",
"description": "string",
"register_downtime": true,
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"current_start_at": "2019-08-24T14:15:22Z",
"current_end_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdBrokenPages

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

Responses

Response samples

200
403

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
}

getDomainsDomainIdSeoIssues

List SEO issues

path Parameters

domain_id

required

integer <int32>

query Parameters

classification	string Enum: "alert" "warning" "info" "technical" Issue Priority
sort_by	string Default: "name" Enum: "name" "pages_count"
status	string Enum: "active" "ignored"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"name": "string",
"classification": 0,
"active": true,
"pages_count": 0,
"ignored": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdSeoIssuesIssueIdContent

Content info for an issue (like duplicate_title)

path Parameters

issue_id required	integer <int32>
domain_id required	integer <int32>

query Parameters

search	string Title/Header search
sort_by	string Default: "title" Enum: "title" "page_count"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"title": "string",
"page_count": "string"
}

getDomainsDomainIdSeoIssuesIssueIdPages

Pages for a given issue

path Parameters

issue_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
content	string

Responses

Response samples

200
403
404

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
}

patchDomainsDomainIdSeoIssuesIssueId

Ignored/Unignore a issue

path Parameters

issue_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

ignored	boolean
content	string

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
400
403
404

Content type

application/json

{"id": 0,
"name": "string",
"classification": 0,
"active": true,
"pages_count": 0,
"ignored": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdSeoPages

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

Responses

Response samples

200
403

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
}

getDomainsDomainIdSeoSummary

Summary

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"pages_with_seo_errors": 0,
"seo_errors": 0,
"pages_count": 0,
"compliance_percentage": 0,
"seo_errors_alerts_count": 0,
"seo_errors_warnings_count": 0,
"seo_errors_infos_count": 0,
"seo_errors_technicals_count": 0
}

getDomainsDomainIdSpellingErrors

List Spelling errors

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string
language	string
sort_by	string Enum: "word" "html_pages_count" "documents_count"
classification	string Enum: "potential" "confirmed"
page_fixed	boolean
labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "desc" Enum: "asc" "desc"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"domain_id": "string",
"language": "string",
"html_pages_count": "string",
"documents_count": "string",
"classification": "string",
"groups": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdSpellingErrorsErrorIdPages

Get pages for a spelling error

path Parameters

error_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

200
403
404

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
}

deleteDomainsDomainIdSpellingErrorsErrorId

Mark spelling error fixed

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchDomainsDomainIdSpellingErrorsErrorId

Patch a spelling error

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>

Request Body schema: application/json

classification	string Enum: "potential" "confirmed"
labels	Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"classification": "potential",
"labels": [0
]
}

Response samples

200
403
404

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"domain_id": "string",
"language": "string",
"html_pages_count": "string",
"documents_count": "string",
"classification": "string",
"groups": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

getDomainsDomainIdSpellingErrorsErrorId

Get a spelling error

path Parameters

error_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"word": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"domain_id": "string",
"language": "string",
"html_pages_count": "string",
"documents_count": "string",
"classification": "string",
"groups": "string",
"page_fixed": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}

postDomainsDomainIdSpellingDictionary

Add word to dictionary

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

word required	string
classification	string Default: "dictionary" Enum: "dictionary" "ignore"
language	string

Responses

Request samples

Payload

Content type

application/json

{"word": "string",
"classification": "dictionary",
"language": "string"
}

Response samples

201
403

Content type

application/json

{"id": "string",
"customer_id": "string",
"word": "string",
"language": "string",
"classification": "string",
"added_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdSpellingDictionary

List words in dictionary

path Parameters

domain_id

required

integer <int32>

query Parameters

search	string
language	string
classification	string Enum: "dictionary" "ignore"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"customer_id": "string",
"word": "string",
"language": "string",
"classification": "string",
"added_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteDomainsDomainIdSpellingDictionaryWordId

Remove word from dictionary

path Parameters

word_id required	integer <int32>
domain_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"customer_id": "string",
"word": "string",
"language": "string",
"classification": "string",
"added_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getDomainsDomainIdSpellingLanguages

List languages

path Parameters

domain_id

required

integer <int32>

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"lang": "string",
"html_page_count": 0,
"confirmed_misspellings_count": 0,
"potential_misspellings_count": 0,
"page_count": 0
}

getDomainsDomainIdSpellingPages

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
classification	string Enum: "potential" "confirmed"
language	string Filtery by language code

Responses

Response samples

200
403

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
}

getDomainsDomainIdSpellingSummary

Summary

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"languages": 0,
"confirmed_misspellings": 0,
"potential_misspellings": 0
}

getDomainsDomainIdStatisticsEventsNames

Get Event names data

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_by	string Default: "event_count" Enum: "label" "event_count" "avg_event_value" "event_name"
search	string

Responses

Response samples

200
403

Content type

application/json

{"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_actions": {"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_names": { }
}
}

getDomainsDomainIdStatisticsEventsActions

Get Event actions data

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_by	string Default: "event_count" Enum: "label" "event_count" "avg_event_value" "event_action"
search	string

Responses

Response samples

200
403

Content type

application/json

{"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_names": {"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_actions": { }
}
}

getDomainsDomainIdStatisticsEventsCategories

Get Event categories data

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "event_count" Enum: "label" "event_count" "avg_event_value" "event_category"
search	string

Responses

Response samples

200
403

Content type

application/json

{"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_actions": {"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_names": {"label": "string",
"uniq_visitors": "string",
"visits": "string",
"event_count": "string",
"avg_event_value": "string",
"event_actions": { }
}
}
}

getDomainsDomainIdStatisticsMostPopularPages

Get pages with most visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "visits" Value: "visits"
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0,
"title": "string"
}

getDomainsDomainIdStatisticsLeastPopularPages

Get pages with least visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "visits" Value: "visits"
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0,
"title": "string"
}

getDomainsDomainIdStatisticsEntryPages

Get entry pages

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "entry_visits" Enum: "visits" "bounce_rate" "entry_visits"
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": "string",
"exit_visits": 0,
"exit_rate": 0,
"title": "string"
}

getDomainsDomainIdStatisticsExitPages

Get exit pages

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
sort_by	string Default: "exit_visits" Enum: "visits" "bounce_rate" "exit_visits"
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": "string",
"exit_rate": 0,
"title": "string"
}

getDomainsDomainIdStatisticsPagesWithoutVisits

Get pages without visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
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"
search	string

Responses

Response samples

200
403

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
}

getDomainsDomainIdStatisticsDocumentsWithoutDownloads

Get documents without downloads

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
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"
search	string

Responses

Response samples

200
403

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
}

postDomainsDomainIdStatisticsPagesByUrl

Request pages and documents by url

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
urls required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"from": "2023-05-19",
"to": "2023-05-26",
"urls": ["string"
]
}

Response samples

201
403
404

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0,
"title": "string"
}

getDomainsDomainIdStatisticsSearchEngines

Get search_engines

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsReferrers

Get referrers

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsKeywords

Get keywords

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403
404

Content type

application/json

{"word": "string",
"visits": "string",
"actions": "string",
"bounce_rate": "string"
}

getDomainsDomainIdStatisticsSocials

Get social referrers

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsVisitors

Get a list of all visitors

path Parameters

domain_id

required

integer <int32>

query Parameters

type	string Default: "total" Enum: "total" "direct" "organic" "paid" "referring" "social"
country	string
region	string
from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsOrganizations

Get a list of organizations

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsBrowsers

Get a list of browsers

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsOs

Get a list of operating systems

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsLanguages

Get a list of languages

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsDevices

Get a list of devices

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsResolutions

Get a list of resolutions

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsLocations

Get a list of locations (countries) with visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsRegions

Get a list of regions with visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
country_code	string
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsCities

Get a list of cities with visits

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
country_code	string
region_code	string DEPRECATED! use 'region_label' instead
region_label	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"visits": 0,
"url": "string",
"visitors": 0,
"uniq_visitors": 0,
"label": "string",
"bounce_rate": 0,
"bounces": 0,
"actions": 0,
"avg_time": 0,
"pageviews": 0,
"time": 0,
"entry_visits": 0,
"exit_visits": 0,
"exit_rate": 0
}

getDomainsDomainIdStatisticsSummary

Get summary

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
country	string
region	string

Responses

Response samples

200
403
404

Content type

application/json

{"date": "string",
"visits": "string",
"visitors": 0,
"avg_time": "string",
"bounce_rate": "string",
"avg_actions": "string",
"pageviews": "string",
"uniq_pageviews": 0,
"bounce_count": 0
}

getDomainsDomainIdStatisticsSummaryPerDate

Get summary per date

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
country	string
region	string

Responses

Response samples

200
403
404

Content type

application/json

{"date": "string",
"visits": "string",
"visitors": 0,
"avg_time": "string",
"bounce_rate": "string",
"avg_actions": "string",
"pageviews": "string",
"uniq_pageviews": 0,
"bounce_count": 0
}

getDomainsDomainIdStatisticsDownloads

Get downloads data

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
search	string

Responses

Response samples

200
403

Content type

application/json

{"date": "2019-08-24",
"url": "string",
"label": "string",
"title": "string",
"downloads": 0,
"pageviews": 0,
"uniq_visitors": 0
}

postDomainsDomainIdStatisticsDownloadsByUrl

Request downloads by url

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
urls required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"from": "2023-05-19",
"to": "2023-05-26",
"urls": ["string"
]
}

Response samples

201
403
404

Content type

application/json

{"date": "2019-08-24",
"url": "string",
"label": "string",
"title": "string",
"downloads": 0,
"pageviews": 0,
"uniq_visitors": 0
}

getDomainsDomainIdStatisticsSiteSearchKeywords

Get site search keywords with results

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
search	string
sort_by	string Default: "visits" Enum: "label" "visits" "pageviews" "pages_per_search" "exit_rate"

Responses

Response samples

200
403

Content type

application/json

{"label": "string",
"visits": 0,
"pageviews": 0,
"pages_per_search": 0,
"bounce_rate": "string",
"exit_rate": "string",
"exit_visits": 0,
"avg_time": 0,
"sum_time": 0
}

getDomainsDomainIdStatisticsSiteSearchNoResultKeywords

Get site search keywords without results

path Parameters

domain_id

required

integer <int32>

query Parameters

from	string <date> Default: "2023-05-19"
to	string <date> Default: "2023-05-26"
limit	integer <int32> Default: 15
page	integer <int32> Default: 1
sort_dir	string Default: "desc" Enum: "asc" "desc"
search	string
sort_by	string Default: "visits" Enum: "label" "visits" "pageviews" "pages_per_search" "exit_rate"

Responses

Response samples

200
403

Content type

application/json

{"label": "string",
"visits": 0,
"pageviews": 0,
"pages_per_search": 0,
"bounce_rate": "string",
"exit_rate": "string",
"exit_visits": 0,
"avg_time": 0,
"sum_time": 0
}

getDomainsDomainIdQualityPages

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

Responses

Response samples

200
403

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
}

getDomainsDomainIdQualitySummary

Get a Quality Summary

path Parameters

domain_id

required

integer <int32>

Responses

Response samples

200
403

Content type

application/json

{"broken_links": 0,
"pages_with_broken_links": 0,
"broken_images": 0,
"pages_with_broken_images": 0,
"confirmed_misspellings": 0,
"potential_misspellings": 0,
"potential_ni_numbers": 0,
"pages_with_confirmed_misspellings": 0,
"pages_with_potential_misspellings": 0,
"pages_with_quality_notifications": 0,
"pages_without_quality_notifications": 0,
"quality_notifications": 0,
"documents_with_broken_links": 0,
"documents_with_broken_images": 0,
"documents_with_confirmed_misspellings": 0,
"documents_with_potential_misspellings": 0,
"documents_with_quality_notifications": 0,
"documents_without_quality_notifications": 0,
"pages_with_quality_notifications_not_searches": 0,
"documents_with_quality_notifications_not_searches": 0
}

heatmaps_rules

Operations about heatmaps_rules

getHeatmapsRules

List heatmaps rules

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"domain_id": "string",
"page_id": "string",
"heatmap_type": "string",
"page": {"id": "string",
"url": "string",
"title": "string"
},
"created_at": "string",
"updated_at": "string"
}

info_types

Operations about info_types

getInfoTypes

List info types for data protection

query Parameters

search	string
sort_by	string Default: "name" Enum: "name" "group" "priority"
priority	string
regulations	Array of strings Items Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA"
regions	Array of strings Items Enum: "global" "argentina" "australia" "belgium" "brazil" "canada" "chile" "china" "colombia" "denmark" "finland" "france" "germany" "hong_kong" "india" "indonesia" "ireland" "israel" "italy" "japan" "korea" "mexico" "norway" "paraguay" "peru" "poland" "portugal" "singapore" "spain" "sweden" "taiwan" "thailand" "the_netherlands" "turkey" "united_kingdom" "united_states" "uruguay" "venezuela"
group	Array of strings Items Enum: "banking_data" "driving_permit" "general_personal_data" "healthcare" "national_id" "other" "sensitive_personal_data" "taxpayer_id" "technical" "product_identifier" "personal_technical"
compliant	boolean
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": 0,
"identifier": "string",
"name": "string",
"priority": "string",
"regions": ["string"
],
"group": "string",
"regulations": ["string"
],
"deprecated": true
}

jobs

Operations about jobs

getJobsJid

Get task

path Parameters

jid

required

string

Job ID

Responses

Response samples

200
403

Content type

application/json

{"jid": "string",
"state": "string"
}

labels

Operations about labels

postLabels

Create label

Request Body schema: application/json

name required	string
color required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getLabels

List labels

query Parameters

search	string Search for label name
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

deleteLabelsLabelId

Delete label

path Parameters

label_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchLabelsLabelId

Update label

path Parameters

label_id

required

integer <int32>

Request Body schema: application/json

name	string
color	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"color": "string"
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getLabelsLabelId

Get label

path Parameters

label_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getLabelsLabelIdDomainsWithBlockingGroups

Get domain_groups using the label

path Parameters

label_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"active": true,
"id": 0,
"title": "string",
"url": "string",
"domain_groups": [{"id": 0,
"title": "string"
}
]
}

me

Operations about mes

patchMe

Update profile

Request Body schema: application/json

first_name	string
last_name	string
locale	string Enum: "da" "en" "nl" "sv"
email	string
timezone	string
title	string
description	string
phone	string
contact_info	object
password	string
password_confirmation	string
auth_user_password	string
	object
	object
privacy_policy_version_accepted	string Value: "20190224"
	object

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"locale": "da",
"email": "string",
"timezone": "string",
"title": "string",
"description": "string",
"phone": "string",
"contact_info": { },
"password": "string",
"password_confirmation": "string",
"auth_user_password": "string",
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"email_notifications": {"exports": true
},
"privacy_policy_version_accepted": "20190224",
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
}
}

Response samples

200
403

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string",
"api_key": "string",
"intercom_user_hash": "string",
"privacy_policy": {"version": "string",
"accepted_at": "2019-08-24T14:15:22Z"
}
}

getMe

Own profile

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string",
"api_key": "string",
"intercom_user_hash": "string",
"privacy_policy": {"version": "string",
"accepted_at": "2019-08-24T14:15:22Z"
}
}

patchMeDomainsDomainId

Update the auth_user' settings for a domain

path Parameters

domain_id

required

integer <int32>

Request Body schema: application/json

favorite	boolean
send_report	boolean

Responses

Request samples

Payload

Content type

application/json

{"favorite": true,
"send_report": true
}

Response samples

200
403
404

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"
}
}

getMeExports

Get exports

query Parameters

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

Responses

Response samples

200
403

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"
}

postMeReports

Create report

Request Body schema: application/json

template_id required	integer <int32> Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 Template id
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"template_id": 1,
"targets": [{"id": 0,
"type": "Domain"
}
]
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"targets": {"id": "string",
"type": "string",
"title": "string",
"users": {"id": 0,
"user": {"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string"
}
},
"schedule": "string"
}

deleteMeReportsReportId

Stop receiving report

path Parameters

report_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchMeReportsReportId

Update report

path Parameters

report_id

required

integer <int32>

Request Body schema: application/json

Array of objects

Array

id required	integer <int32>
type required	string Enum: "Domain" "DomainGroup"

Responses

Request samples

Payload

Content type

application/json

{"targets": [{"id": 0,
"type": "Domain"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"targets": {"id": "string",
"type": "string",
"title": "string",
"users": {"id": 0,
"user": {"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string"
}
},
"schedule": "string"
}

postMeReportings

Create reporting

Request Body schema: application/json

template_id required	integer <int32> Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
target_type required	string Enum: "Domain" "DomainGroup"
target_id required	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"template_id": 1,
"target_type": "Domain",
"target_id": 0
}

Response samples

201
400
403
404

Content type

application/json

{"id": "string",
"user_id": "string",
"state": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"target": {"id": "string",
"type": "string"
},
"title": "string",
"content_type": "string",
"url": "string",
"token": "string",
"created_at": "string"
}

getMeReportings

Get reportings

query Parameters

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" Enum: "title" "id" "created_at" "state"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"user_id": "string",
"state": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"target": {"id": "string",
"type": "string"
},
"title": "string",
"content_type": "string",
"url": "string",
"token": "string",
"created_at": "string"
}

getMeReportingsReportingId

Get reporting

path Parameters

reporting_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"user_id": "string",
"state": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"target": {"id": "string",
"type": "string"
},
"title": "string",
"content_type": "string",
"url": "string",
"token": "string",
"created_at": "string"
}

performance

Operations about performances

postPerformanceAssignedProfiles

Set performance scan profiles to a page

Request Body schema: application/json

page_id required	integer <int32> Identifier for the page to run the profile against
default_profile_id required	integer <int32> Identifier of the default profile to run on the page
profile_ids required	Array of integers <int32> [ items <int32 > ] Identifiers of the profiles to run on the page
scan_frequency required	integer <int32> Enum: 6 12 24 168 How often the scan should run. Measured in hours.

Responses

Request samples

Payload

Content type

application/json

{"page_id": 0,
"default_profile_id": 0,
"profile_ids": [0
],
"scan_frequency": 6
}

Response samples

201
404
422

Content type

application/json

{"id": 0,
"default_profile_id": 0,
"profile_ids": [0
],
"domain_id": 0,
"scan_frequency": 0,
"screenshot": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"scores": {"profile_id": 0,
"scanned_at": "2019-08-24T14:15:22Z",
"performance": 0,
"version": "string",
"first_meaningful_paint": 0,
"first_contentful_paint": 0,
"largest_contentful_paint": 0,
"speed_index": 0,
"total_blocking_time": 0,
"cumulative_layout_shift": 0,
"time_to_interactive": 0
},
"page": {"id": "string",
"domain_id": "string",
"title": "string",
"url": "string",
"lastcheck": "2019-08-24T14:15:22Z"
}
}

getPerformanceAssignedProfiles

Retrieves a list of performance scan profiles and their pages

query Parameters

domain_id	integer <int32> Identifier of the domain to scope pages from
page_id	integer <int32> Identifier of the page to scope from
profile_id	integer <int32> Identifier of the profile to scope from
search	string Filter for pages based on title or url
group_id	integer <int32> Filter for pages based on its group id
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403
404

Content type

application/json

{"id": 0,
"default_profile_id": 0,
"profile_ids": [0
],
"domain_id": 0,
"scan_frequency": 0,
"screenshot": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"scores": {"profile_id": 0,
"scanned_at": "2019-08-24T14:15:22Z",
"performance": 0,
"version": "string",
"first_meaningful_paint": 0,
"first_contentful_paint": 0,
"largest_contentful_paint": 0,
"speed_index": 0,
"total_blocking_time": 0,
"cumulative_layout_shift": 0,
"time_to_interactive": 0
},
"page": {"id": "string",
"domain_id": "string",
"title": "string",
"url": "string",
"lastcheck": "2019-08-24T14:15:22Z"
}
}

patchPerformanceAssignedProfilesAssignedProfileId

Updates settings for performance scan profiles on a page

path Parameters

assigned_profile_id

required

integer <int32>

Request Body schema: application/json

default_profile_id required	integer <int32> Identifier of the default profile to run on the page
profile_ids required	Array of integers <int32> [ items <int32 > ] Identifiers of the profiles to run on the page
scan_frequency required	integer <int32> Enum: 6 12 24 168 How often the scan should run

Responses

Request samples

Payload

Content type

application/json

{"default_profile_id": 0,
"profile_ids": [0
],
"scan_frequency": 6
}

Response samples

200
404
422

Content type

application/json

{"id": 0,
"default_profile_id": 0,
"profile_ids": [0
],
"domain_id": 0,
"scan_frequency": 0,
"screenshot": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"scores": {"profile_id": 0,
"scanned_at": "2019-08-24T14:15:22Z",
"performance": 0,
"version": "string",
"first_meaningful_paint": 0,
"first_contentful_paint": 0,
"largest_contentful_paint": 0,
"speed_index": 0,
"total_blocking_time": 0,
"cumulative_layout_shift": 0,
"time_to_interactive": 0
},
"page": {"id": "string",
"domain_id": "string",
"title": "string",
"url": "string",
"lastcheck": "2019-08-24T14:15:22Z"
}
}

deletePerformanceAssignedProfilesAssignedProfileId

Unassigns a profile from a page

path Parameters

assigned_profile_id

required

integer <int32>

Responses

Response samples

404

Content type

application/json

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

postPerformanceProfiles

Creates a performance profile

Request Body schema: application/json

name required	string
device required	string Enum: "mobile" "desktop" Device type in which to run diagnostics on
description	string Given description of the profile
location required	string Enum: "europe-west1" "australia-southeast1" "us-central1" "asia-southeast1" Location from which to run profile will, if set as default
round_trip_time required	integer <int32> Simulated network server-client time over distance. Measured in Milliseconds
throughput required	integer <int32> Overall speed at which packages reach their destination
request_latency required	integer <int32> Time it takes for the data to travel inside the network
download_throughput required	integer <int32> Time it takes for a package to reach the client (e.g. mobile)
upload_throughput required	integer <int32> Time it takes for a package to reach the server
cpu_slowdown_multiplier required	integer <int32> Multiplier used to throttle CPU speed

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"device": "mobile",
"description": "string",
"location": "europe-west1",
"round_trip_time": 0,
"throughput": 0,
"request_latency": 0,
"download_throughput": 0,
"upload_throughput": 0,
"cpu_slowdown_multiplier": 0
}

Response samples

201
422

Content type

application/json

{"id": 0,
"customer_id": 0,
"name": "string",
"description": "string",
"device": "string",
"round_trip_time": 0,
"throughput": 0,
"request_latency": 0,
"download_throughput": 0,
"upload_throughput": 0,
"cpu_slowdown_multiplier": 0,
"location": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"archived_at": "2019-08-24T14:15:22Z"
}

getPerformanceProfiles

Returns a list of performance profiles available for the customer

query Parameters

page_id	integer <int32> Identifier of the page to scope from
archived	boolean Filter by whether it's been archived
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200

Content type

application/json

{"id": 0,
"customer_id": 0,
"name": "string",
"description": "string",
"device": "string",
"round_trip_time": 0,
"throughput": 0,
"request_latency": 0,
"download_throughput": 0,
"upload_throughput": 0,
"cpu_slowdown_multiplier": 0,
"location": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"archived_at": "2019-08-24T14:15:22Z"
}

patchPerformanceProfilesProfileIdArchived

Archives a performance profile for a given customer

path Parameters

profile_id

required

integer <int32>

Identifier of the profile to run on the page

Request Body schema: application/json

Responses

Request samples

Payload

Content type

application/json

{"archive": true
}

Response samples

403
404

Content type

application/json

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

patchPerformanceProfilesProfileId

Updates a performance profile for a given customer

path Parameters

profile_id

required

integer <int32>

Identifier of the profile to run on the page

Request Body schema: application/json

name	string
description	string Given description of the profile

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
404
422

Content type

application/json

{"id": 0,
"customer_id": 0,
"name": "string",
"description": "string",
"device": "string",
"round_trip_time": 0,
"throughput": 0,
"request_latency": 0,
"download_throughput": 0,
"upload_throughput": 0,
"cpu_slowdown_multiplier": 0,
"location": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"archived_at": "2019-08-24T14:15:22Z"
}

postPerformanceScans

Enqueues a rescan for a given page with a performance profile

Request Body schema: application/json

page_id required	integer <int32> Identifier of the page to scope from
profile_id required	integer <int32> Identifier of the profile to run on the page

Responses

Request samples

Payload

Content type

application/json

{"page_id": 0,
"profile_id": 0
}

Response samples

201
422

Content type

application/json

{"page_id": 0,
"profile_id": 0,
"status": "string",
"created_at": "2019-08-24T14:15:22Z",
"error": {"code": 0,
"message": "string"
}
}

getPerformanceScans

Retrieves the scan status for a given page with a performance profile

query Parameters

page_id required	integer <int32> Identifier of the page to scope from
profile_id	integer <int32> Identifier of the profile to run on the page
page_size	integer <int32> Default: 10 Limit the amount of records to retrieve

Responses

Response samples

200
422

Content type

application/json

{"page_id": 0,
"profile_id": 0,
"status": "string",
"created_at": "2019-08-24T14:15:22Z",
"error": {"code": 0,
"message": "string"
}
}

getPerformanceResults

Returns a performance scan result for a given page with a profile

query Parameters

profile_id required	integer <int32> Profile identifier
page_id required	integer <int32> Page identifier
from	string <date> Initial date to filter from
to	string <date> End date date to filter from
limit	integer <int32> Default: 10 Limit the amount of records to retrieve

Responses

Response samples

200
422

Content type

application/json

{"profile_id": 0,
"scanned_at": "2019-08-24T14:15:22Z",
"performance": 0,
"version": "string",
"first_meaningful_paint": 0,
"first_contentful_paint": 0,
"largest_contentful_paint": 0,
"speed_index": 0,
"total_blocking_time": 0,
"cumulative_layout_shift": 0,
"time_to_interactive": 0,
"page_id": 0
}

getPerformanceReports

Retrieves the latest report for a given page and profile

query Parameters

page_id required	integer <int32> Identifier of the page to scope from
profile_id required	integer <int32> Identifier of the profile that ran on the page

Responses

Response samples

200
422

Content type

application/json

{"audits": "string",
"categories": "string",
"categoryGroups": "string",
"configSettings": "string",
"environment": "string",
"fetchTime": "string",
"finalUrl": "string",
"i18n": "string",
"lighthouseVersion": "string",
"version": "string",
"requestedUrl": "string",
"runWarnings": "string",
"timing": "string",
"userAgent": "string"
}

plans

Operations about plans

getPlans

List plans

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"name": "string",
"code": "string",
"group": "string",
"price": "string",
"unique_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,
"multiple_user_agreements": 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
]
},
"active": "string",
"type": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

policies

Operations about policies

postPolicies

Create policy

Request Body schema: application/json

name required	string
mode required	string Enum: "search" "violation" "required"
subject required	string Enum: "page" "page_html" "page_html_text" "page_document" "link"
rules_operator required	string Enum: "and" "or"
required	Array of objects
scheduled required	boolean
note	string Default: ""
priority	string Enum: "low" "medium" "high"
tags	Array of strings Items Enum: "qa" "accessibility" "seo"
template	string
labels	Array of integers <int32> [ items <int32 > ]
target_all_domains	boolean Default: false All domains auto-targeted if enabled
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"mode": "search",
"subject": "page",
"rules_operator": "and",
"rules": [{"name": "string",
"type": "external_link_count",
"operator": "starts_with",
"query": "string",
"case_sensitive": true,
"inverse": true,
"sub_entry": "string",
"multiline": false,
"css_filters": {"limit": ["string"
],
"exclude": ["string"
]
}
}
],
"scheduled": true,
"note": "",
"priority": "low",
"tags": ["qa"
],
"template": "string",
"labels": [0
],
"target_all_domains": false,
"targets": [{"id": 0,
"type": "Domain"
}
]
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getPolicies

List Policies

query Parameters

labels	Array of integers <int32> [ items <int32 > ]
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_by	string Default: "matches_count" Enum: "name" "matches_count" "pages_count" "links_count" "created_at" "first_name"
sort_dir	string Default: "desc" Enum: "asc" "desc"
mode	string Enum: "search" "violation" "required"
search	string Filter policies by their name
archived	boolean Show only archived or active policies
scheduled	boolean
tags	Array of strings

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

created_by

Array of integers <int32> [ items <int32 > ]

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getPoliciesAuthors

List users who created policies

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
}

postPoliciesPolicyIdRun

Run policy matching

path Parameters

policy_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

deletePoliciesPolicyId

Delete policy

path Parameters

policy_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchPoliciesPolicyId

Update policy

path Parameters

policy_id

required

integer <int32>

Request Body schema: application/json

name	string
mode	string Enum: "search" "violation" "required"
note	string
priority	string Enum: "low" "medium" "high"
rules_operator	string Enum: "and" "or"
	Array of objects
scheduled	boolean
tags	Array of strings Items Enum: "qa" "accessibility" "seo"
target_all_domains	boolean All domains auto-targeted if enabled
archived	boolean
labels	Array of integers <int32> [ items <int32 > ]
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"mode": "search",
"note": "string",
"priority": "low",
"rules_operator": "and",
"rules": [{"name": "string",
"type": "external_link_count",
"operator": "starts_with",
"query": "string",
"case_sensitive": true,
"inverse": true,
"sub_entry": "string",
"multiline": false,
"css_filters": {"limit": ["string"
],
"exclude": ["string"
]
}
}
],
"scheduled": true,
"tags": ["qa"
],
"target_all_domains": true,
"archived": true,
"labels": [0
],
"targets": [{"id": 0,
"type": "Domain"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

getPoliciesPolicyId

Get policy

path Parameters

policy_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"name": "string",
"note": "string",
"mode": "string",
"priority": "string",
"rules": {"name": "string",
"type": "string",
"operator": "string",
"query": "string",
"case_sensitive": "string",
"multiline": "string",
"inverse": "string",
"sub_entry": "string",
"css_filters": {"limit": "string",
"exclude": "string"
},
"js_regex": {"source": "string",
"options": "string"
}
},
"rules_operator": "string",
"scheduled": "string",
"state": "string",
"subject": "string",
"targets": {"id": "string",
"type": "string",
"title": "string",
"latest_run_at": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string"
},
"tags": "string",
"target_all_domains": true,
"template": "string",
"pages_count": "string",
"links_count": "string",
"matches_count": "string",
"archived_at": "2019-08-24T14:15:22Z",
"created_by": {"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

reports

Operations about reports

postReports

Create report

Request Body schema: application/json

template_id required	integer <int32> Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 Template id
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"template_id": 1,
"targets": [{"id": 0,
"type": "Domain",
"users": [{"user_id": 0,
"email": "string",
"first_name": "string",
"last_name": "string"
}
]
}
]
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"targets": {"id": "string",
"type": "string",
"title": "string",
"users": {"id": 0,
"user": {"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string"
}
},
"schedule": "string"
}

getReports

List reports

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"targets": {"id": "string",
"type": "string",
"title": "string",
"users": {"id": 0,
"user": {"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string"
}
},
"schedule": "string"
}

deleteReportsReportId

Delete report

path Parameters

report_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchReportsReportId

Update report

path Parameters

report_id

required

integer <int32>

Request Body schema: application/json

Array of objects

Array

id required	integer <int32>
type required	string Enum: "Domain" "DomainGroup"
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"targets": [{"id": 0,
"type": "Domain",
"users": [{"user_id": 0,
"email": "string",
"first_name": "string",
"last_name": "string"
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"template": {"id": "string",
"name": "string",
"title": "string",
"priority": "string",
"schedulable": "string",
"target_required": "string",
"domain_only": "string"
},
"targets": {"id": "string",
"type": "string",
"title": "string",
"users": {"id": 0,
"user": {"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string"
}
},
"schedule": "string"
}

scores

Operations about scores

getScores

List scores

Responses

Response samples

200
403

Content type

application/json

{"vertical": "string",
"vertical_averages": {"module": "string",
"score": 0
}
}

support

Operations about supports

postSupportRequest

Create a request

Request Body schema: application/json

code required	string Enum: "performance" "data-privacy"
message required	string

Responses

Request samples

Payload

Content type

application/json

{"code": "performance",
"message": "string"
}

Response samples

403

Content type

application/json

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

postSupportFeedback

Create feedback

Request Body schema: application/json

recipient_name required	string
recipient_email required	string
message required	string

Responses

Request samples

Payload

Content type

application/json

{"recipient_name": "string",
"recipient_email": "string",
"message": "string"
}

Response samples

403

Content type

application/json

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

users

Operations about users

postUsers

Create user

Request Body schema: application/json

first_name required	string
last_name	string
locale	string Enum: "da" "en" "nl" "sv"
email required	string
send_welcome_email	boolean Default: true
customer_admin	boolean Default: false
timezone	string
title	string
description	string
phone	string
	object
	Array of objects
	Array of objects
labels	Array of integers <int32> [ items <int32 > ]
	object

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"locale": "da",
"email": "string",
"send_welcome_email": true,
"customer_admin": false,
"timezone": "string",
"title": "string",
"description": "string",
"phone": "string",
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"domain_users": [{"visible": true,
"send_report": true,
"domain_id": 0
}
],
"domain_group_members": [{"visible": true,
"send_report": true,
"domain_group_id": 0,
"id": 0
}
],
"labels": [0
],
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
}
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string"
}

getUsers

List users

query Parameters

search	string
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "name" Enum: "first_name" "last_name" "name" "last_login_at"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
labels	Array of integers <int32> [ items <int32 > ]
admin	boolean
extended	boolean Default: true

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string"
}

deleteUsersUserId

Delete user

path Parameters

user_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchUsersUserId

Update user

path Parameters

user_id

required

integer <int32>

Request Body schema: application/json

first_name	string
last_name	string
locale	string Enum: "da" "en" "nl" "sv"
email	string
customer_admin	boolean
timezone	string
title	string
description	string
phone	string
	object
	object
	Array of objects
	Array of objects
password	string
password_confirmation	string
auth_user_password	string
labels	Array of integers <int32> [ items <int32 > ]
	object

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"locale": "da",
"email": "string",
"customer_admin": true,
"timezone": "string",
"title": "string",
"description": "string",
"phone": "string",
"email_notifications": {"exports": true
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"domain_users": [{"id": 0,
"visible": true,
"send_report": true,
"domain_id": 0
}
],
"domain_group_members": [{"visible": true,
"send_report": true,
"domain_group_id": 0,
"id": 0
}
],
"password": "string",
"password_confirmation": "string",
"auth_user_password": "string",
"labels": [0
],
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
}
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string"
}

getUsersUserId

Get user

path Parameters

user_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"locale": "string",
"timezone": "string",
"contact_info": {"phone": "string",
"industry": "string"
},
"social_media": {"facebook": "string",
"twitter": "string",
"linkedin": "string"
},
"title": "string",
"description": "string",
"phone": "string",
"otp": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_login_at": "2019-08-24T14:15:22Z",
"customer_admin": "string",
"customer": {"id": 0,
"name": "string",
"attention": "string",
"address": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"country": "string",
"vat_number": "string",
"phone_number": "string",
"timezone": "string",
"salesforce_account_id": "string",
"source": "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"
},
"subscription": {"billing_method": "string",
"plan": {"id": "string",
"name": "string"
},
"plan_id": 0,
"subscription_start_at": "2019-08-24T14:15:22Z",
"plan_overrides": {"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,
"multiple_user_agreements": 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
]
},
"clarity_tokens": "string"
},
"account_suspended": true,
"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",
"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"
},
"domains_count": 0,
"users_count": 0,
"vertical": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"labels": {"id": "string",
"name": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"settings": {"dashboard": { },
"accessibility": true,
"modules": ["string"
]
},
"email_notifications": "string",
"association_level": "string"
}

spelling_tool

Operations about spelling_tools

getSpellingToolLanguages

List a languages supported by the spelling tool

Responses

Response samples

403

Content type

application/json

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

social

Operations about socials

postSocialFacebookPages

Add Facebook page

Request Body schema: application/json

page_id required	string
name required	string
access_token required	string

Responses

Request samples

Payload

Content type

application/json

{"page_id": "string",
"name": "string",
"access_token": "string"
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"page_id": "string",
"name": "string",
"posts": {"data": {"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
},
"paging": {"before": "string",
"after": "string"
}
}
}

getSocialFacebookPages

List Facebook pages

query Parameters

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

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"page_id": "string",
"name": "string",
"posts": {"data": {"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
},
"paging": {"before": "string",
"after": "string"
}
}
}

deleteSocialFacebookPagesPageId

Remove Facebook page

path Parameters

page_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchSocialFacebookPagesPageId

Update Facebook page

path Parameters

page_id

required

string

Request Body schema: application/json

name	string
access_token	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"access_token": "string"
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"page_id": "string",
"name": "string",
"posts": {"data": {"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
},
"paging": {"before": "string",
"after": "string"
}
}
}

getSocialFacebookPagesPageId

Get Facebook page

path Parameters

page_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"page_id": "string",
"name": "string",
"posts": {"data": {"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
},
"paging": {"before": "string",
"after": "string"
}
}
}

getSocialFacebookPagesPageIdPosts

List Facebook page posts

path Parameters

page_id

required

integer <int32>

query Parameters

limit	integer <int32> Default: 10 Page size
before	string Previous page hash
after	string Next page hash

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
},
"paging": {"before": "string",
"after": "string"
}
}

getSocialFacebookPagesPageIdPostsPostId

Get Facebook post

path Parameters

post_id required	string
page_id required	integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"message": "string",
"comments": {"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"reactions": {"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
},
"sharedposts": {"data": {"id": "string",
"message": "string"
}
}
}

getSocialFacebookPagesPageIdPostsPostIdComments

List Facebook page posts

path Parameters

page_id required	integer <int32>
post_id required	integer <int32>

query Parameters

limit	integer <int32> Default: 10 Page size
before	string Previous page hash
after	string Next page hash

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": "string",
"from": {"id": "string",
"name": "string"
},
"message": "string",
"created_time": "string"
},
"paging": {"before": "string",
"after": "string"
}
}

getSocialFacebookPagesPageIdPostsPostIdReactions

List Facebook page posts

path Parameters

page_id required	integer <int32>
post_id required	integer <int32>

query Parameters

limit	integer <int32> Default: 10 Page size
before	string Previous page hash
after	string Next page hash

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": "string",
"name": "string",
"type": "string"
},
"paging": {"before": "string",
"after": "string"
}
}

getSocialFacebookPagesPageIdPostsPostIdSharedposts

List Facebook page posts

path Parameters

page_id required	integer <int32>
post_id required	integer <int32>

query Parameters

limit	integer <int32> Default: 10 Page size
before	string Previous page hash
after	string Next page hash

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": "string",
"message": "string"
}
}

audit_logs

Operations about audit_logs

Get logs in the audit_log

Non admin users only have permission to see AccessibilityCheck audit entries

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_by	string Default: "created_at" Enum: "id" "created_at" "author"
sort_dir	string Default: "desc" Enum: "asc" "desc"
domain_id	integer <int32>
user_id	integer <int32>
type	string
target	string
from	string <date-time>
to	string <date-time>
module	string Enum: "accessibility" "settings" "qa" "policies" "seo" "uptime" "page_correct" "report" "api_users" "single_page_scan" "user" "data_protection" "performance" "heatmaps_rules" "core"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"domain": {"id": "string",
"title": "string"
},
"author": "string",
"target_uri": "string",
"created_at": "2019-08-24T14:15:22Z",
"action": "string",
"data": { },
"module": "string"
}

agreements

Operations about agreements

getAgreements

Own account agreements

Responses

Response samples

200
403

Content type

application/json

{"account": {"id": "string",
"type": "string",
"name": "string"
},
"admin": "string",
"domain_group_members": {"send_report": true,
"visible": true,
"domain_group_id": 0,
"user_id": 0,
"id": 0
},
"domain_users": {"send_report": true,
"visible": true,
"domain_id": 0,
"user_id": 0,
"id": 0
},
"settings": "string",
"support": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

notifications

Operations about notifications

getNotifications

List notifications

query Parameters

filter	string Value: "new"
updated_after	string <date-time>
sort_by	string Default: "updated_at" Enum: "stage" "created_at" "updated_at" "done_at"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"stage": "string",
"action": "string",
"target": "string",
"target_id": 0,
"scopes": {"id": "string",
"type": "string"
},
"payload": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"done_at": "2019-08-24T14:15:22Z"
}

shortcuts

Operations about shortcuts

postShortcuts

Create Shortcut

Request Body schema: application/json

title required	string
url required	string
icon_uri required	string
icon_type required	string
position	integer <int32> Default: -1
private required	boolean Default: false
url_target required	string
on_dashboard required	boolean

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": -1,
"private": false,
"url_target": "string",
"on_dashboard": true
}

Response samples

201
400
403

Content type

application/json

{"id": 0,
"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": 0,
"url_target": "string",
"on_dashboard": true,
"private": true
}

getShortcuts

Get shortcuts

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
private	boolean
search	string

Responses

Response samples

200
400
403

Content type

application/json

{"id": 0,
"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": 0,
"url_target": "string",
"on_dashboard": true,
"private": true
}

deleteShortcutsShortcutId

Delete Shortcut

path Parameters

shortcut_id

required

integer <int32>

Responses

Response samples

200
400
403

Content type

application/json

{"id": 0,
"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": 0,
"url_target": "string",
"on_dashboard": true,
"private": true
}

patchShortcutsShortcutId

Update Shortcut

path Parameters

shortcut_id

required

integer <int32>

Request Body schema: application/json

title	string
url	string
icon_uri	string
icon_type	string
position	integer <int32>
private	boolean Default: false
url_target	string
on_dashboard	boolean

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": 0,
"private": false,
"url_target": "string",
"on_dashboard": true
}

Response samples

200
400
403

Content type

application/json

{"id": 0,
"title": "string",
"url": "string",
"icon_uri": "string",
"icon_type": "string",
"position": 0,
"url_target": "string",
"on_dashboard": true,
"private": true
}

api_users

Operations about api_users

postApiUsers

Create Api user

Request Body schema: application/json

description required	string
scopes	Array of strings Items Enum: "cms" "customer" "customer_admin"

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"scopes": ["cms"
]
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"description": "string",
"token": "string",
"scopes": "string"
}

getApiUsers

List Api users

query Parameters

sort_by	string Default: "id" Enum: "id" "description"
sort_dir	string Default: "desc" Enum: "asc" "desc"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"description": "string",
"token": "string",
"scopes": "string"
}

deleteApiUsersApiUserId

Delete Api user

path Parameters

api_user_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

getApiUsersApiUserId

Get Api user

path Parameters

api_user_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"description": "string",
"token": "string",
"scopes": "string"
}

postApiUsersApiUserIdRevokeToken

Revoke current token and generate a new one

path Parameters

api_user_id

required

integer <int32>

Responses

Response samples

201
403
404

Content type

application/json

{"id": "string",
"description": "string",
"token": "string",
"scopes": "string"
}

source_code_excludes

Operations about source_code_excludes

postSourceCodeExcludes

Create source code exclude

Request Body schema: application/json

title required	string
module required	string Enum: "spelling" "readability"
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

{"title": "string",
"module": "spelling",
"rules": [{"operator": "css",
"value": "string"
}
],
"default_for_cms": "sitecore"
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"owner_type": "string",
"title": "string",
"rules": "string",
"default_for_cms": "string"
}

getSourceCodeExcludes

List source code excludes

query Parameters

page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
include_inherited	boolean Default: false
module	string Enum: "spelling" "readability"
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "title" Enum: "id" "title" "module"

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"owner_type": "string",
"title": "string",
"rules": "string",
"default_for_cms": "string"
}

deleteSourceCodeExcludesExcludeId

Delete source code exclude

path Parameters

exclude_id

required

integer <int32>

Responses

Response samples

403
404

Content type

application/json

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

patchSourceCodeExcludesExcludeId

Update source code exclude

path Parameters

exclude_id

required

integer <int32>

Request Body schema: application/json

title	string
module	string Enum: "spelling" "readability"
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"
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"module": "spelling",
"default_for_cms": "sitecore",
"rules": [{"operator": "css",
"value": "string"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"id": "string",
"owner_type": "string",
"title": "string",
"rules": "string",
"default_for_cms": "string"
}

getSourceCodeExcludesExcludeId

Get source code exclude

path Parameters

exclude_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"owner_type": "string",
"title": "string",
"rules": "string",
"default_for_cms": "string"
}

scans

Operations about scans

postScans

Request the scan of a page

Request Body schema: application/json

url required	string URL to be scanned
callback_url	string The URL to be called with the result of the scan upon completion
accessibility	string Default: null Enum: "WCAG2-A" "WCAG2-AA" "WCAG2-AAA" "WCAG21-A" "WCAG21-AA" "WCAG21-AAA" "WCAG22-A" "WCAG22-AA" "WCAG22-AAA" Accessibility guideline
readability_test	string Default: null Enum: "ari" "coleman_liau" "flesch_kincaid_re" "flesch_kincaid_gl" "gunning_fog" "smog" "lix" Readability test
readability_test_min_words	integer <int32> Default: 0 Minimum amount of words required in the text to perform the readability test
classify_links	boolean Default: false Detects the type (link, anchor, email, etc.) of all links present in the page
check_seo	boolean Default: false Analyzes the page for potential SEO issues
check_spelling	boolean Default: false Scans the text for spelling mistakes
spelling_whitelist	Array of strings A list of words that should not be considered as spelling mistakes
spelling_ignore_capitalized	boolean Default: false Ignore capitalized words when checking for spelling mistakes
spelling_locale	string Locale to be used when spellchecking (overrides locale found by the crawler, if any)
data_protection_regulation	string Default: null Enum: "APA" "CCPA" "GDPR" "SHIELD" "PIPEDA" Scan the text for violations of the selected data protection regulation

Responses

Request samples

Payload

Content type

application/json

{"url": "string",
"callback_url": "string",
"accessibility": "WCAG2-A",
"readability_test": "ari",
"readability_test_min_words": 0,
"classify_links": false,
"check_seo": false,
"check_spelling": false,
"spelling_whitelist": ["string"
],
"spelling_ignore_capitalized": false,
"spelling_locale": "string",
"data_protection_regulation": "APA"
}

Response samples

201
400
403

Content type

application/json

{"id": "string",
"url": "string",
"callback_url": "string",
"options": "string",
"status": "string",
"failure_reason": "string",
"created_at": "string",
"scan_result": "string"
}

getScans

List scan requests

query Parameters

requested_by_id	integer <int32> Id of user who requested the scan
from	string <date-time> Fetch scans requested after this date
to	string <date-time> Fetch scans requested before this date
url	string Filter scans by url
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10

Responses

Response samples

200
403

Content type

application/json

{"id": "string",
"url": "string",
"callback_url": "string",
"options": "string",
"status": "string",
"failure_reason": "string",
"created_at": "string",
"scan_result": "string"
}

getScansScanRequestId

Get scan request

path Parameters

scan_request_id

required

integer <int32>

Responses

Response samples

200
403
404

Content type

application/json

{"id": "string",
"url": "string",
"callback_url": "string",
"options": "string",
"status": "string",
"failure_reason": "string",
"created_at": "string",
"scan_result": "string"
}

verticals

Operations about verticals

getVerticals

get list of available verticals

Responses

link_excludes

Operations about link_excludes

getLinkExcludes

List link excludes for a specific CMS

query Parameters

default_for_cms required	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"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "regex" Value: "regex"

Responses

Response samples

200
403

Content type

application/json

{"regex": "string"
}

path_constraints

Operations about path_constraints

getPathConstraints

List path constraints for a specific CMS

query Parameters

default_for_cms required	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"
page	integer <int32> Default: 1
page_size	integer <int32> Default: 10
sort_dir	string Default: "asc" Enum: "asc" "desc"
sort_by	string Default: "constraint" Value: "constraint"

Responses

Response samples

200
403

Content type

application/json

{"constraint": "string"
}

ping

Operations about pings