Skip to main content

Monsido API (1.0.0)

Monsido Customer API

accessibility_guidelines

Operations about accessibility_guidelines

getAccessibilityGuidelines

List accessibility guidelines

Request Body schema: application/x-www-form-urlencoded
abbrs
Array of strings

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "abbr": "string",
  • "mobile": true,
  • "previous_guideline_id": 0,
  • "checks_count": 0,
  • "levels": {
    }
}

getAccessibilityGuidelinesGuidelineId

Get accessibility guideline

path Parameters
guideline_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "abbr": "string",
  • "mobile": true,
  • "previous_guideline_id": 0,
  • "checks_count": 0,
  • "levels": {
    }
}

accessibility_checks

Operations about accessibility_checks

getAccessibilityChecks

List accessibility checks

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "result_type": "string",
  • "tags": [
    ],
  • "difficulty": 0,
  • "impact": "string",
  • "friendly_name": "string",
  • "responsibilities": "string",
  • "labels": {
    },
  • "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

Content type
application/json
[
  • 0
]

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "result_type": "string",
  • "tags": [
    ],
  • "difficulty": 0,
  • "impact": "string",
  • "friendly_name": "string",
  • "responsibilities": "string",
  • "labels": {
    },
  • "previous_check_id": "string",
  • "mobile": "string"
}

accessibility

Operations about accessibilities

deleteAccessibilitySourceCodeExcludesExcludeId

Delete accessibility source code exclude

path Parameters
exclude_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

patchAccessibilitySourceCodeExcludesExcludeId

Update accessibility source code exclude

path Parameters
exclude_id
required
integer <int32>
Request Body schema: application/json
short_description
string
Array of objects
default_for_cms
string
Enum: "sitecore" "special" "custom" "dynamicweb" "umbraco" "wordpress" "wordpress_multisite" "omniupdate" "sitefinity" "publicera" "drupal" "opencities" "plone" "presence" "gabbart" "joomla" "squiz" "silverstripe" "municode" "sitevision" "kentico" "hubspot" "finalsite" "squarespace" "cascade" "elcom" "icreate" "episerver" "acos" "shopify" "adobe" "simsite" "craft" "aem" "konform" "corepublish" "cms_template" "civicengage_central" "civicengage_evolve" "civicengage_open"

Responses

Request samples

Content type
application/json
{
  • "short_description": "string",
  • "match_rules": [
    ],
  • "default_for_cms": "sitecore"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner_type": "string",
  • "short_description": "string",
  • "match_rules": "string",
  • "default_for_cms": "string"
}

getAccessibilitySourceCodeExcludesExcludeId

Get accessibility source code exclude

path Parameters
exclude_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner_type": "string",
  • "short_description": "string",
  • "match_rules": "string",
  • "default_for_cms": "string"
}

postAccessibilitySourceCodeExcludes

Create accessibility source code exclude

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

Responses

Request samples

Content type
application/json
{
  • "short_description": "string",
  • "match_rules": [
    ],
  • "default_for_cms": "sitecore"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner_type": "string",
  • "short_description": "string",
  • "match_rules": "string",
  • "default_for_cms": "string"
}

getAccessibilitySourceCodeExcludes

List accessibility source code excludes

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

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "owner_type": "string",
  • "short_description": "string",
  • "match_rules": "string",
  • "default_for_cms": "string"
}

account

Operations about accounts

patchAccount

Update account

Request Body schema: application/json
name
string
address
string
city
string
zipcode
string
state
string
country
string
vat_number
string
timezone
string
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "city": "string",
  • "zipcode": "string",
  • "state": "string",
  • "country": "string",
  • "vat_number": "string",
  • "timezone": "string",
  • "branding": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "address": "string",
  • "zipcode": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "vat_number": "string",
  • "phone_number": "string",
  • "timezone": "string",
  • "settings": {
    },
  • "branding": {
    },
  • "plan_traits": {
    },
  • "plan_type": "string",
  • "reseller": {
    },
  • "html_pages_count": 0,
  • "documents_count": 0,
  • "vertical": "string"
}

getAccount

Get account

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "address": "string",
  • "zipcode": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "vat_number": "string",
  • "phone_number": "string",
  • "timezone": "string",
  • "settings": {
    },
  • "branding": {
    },
  • "plan_traits": {
    },
  • "plan_type": "string",
  • "reseller": {
    },
  • "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

Content type
application/json
{
  • "subject_type": "string",
  • "subject_id": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "subject_id": "string",
  • "subject_type": "string",
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

getComments

List comments

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

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "subject_id": "string",
  • "subject_type": "string",
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

deleteCommentsCommentId

Delete comment

path Parameters
comment_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

patchCommentsCommentId

Update comment

path Parameters
comment_id
required
integer <int32>
Request Body schema: application/json
comment
required
string

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "subject_id": "string",
  • "subject_type": "string",
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

getCommentsCommentId

Get comment

path Parameters
comment_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user_id": "string",
  • "subject_id": "string",
  • "subject_type": "string",
  • "comment": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

pages

Operations about pages

getPages

List pages

query Parameters
type
string
Enum: "html" "pdf" "document"

Filter on type

types
Array of strings
Items Enum: "html" "pdf" "document"

Filter on multiple types

search
required
string

Title and url search

sort_by
string
Default: "title"
Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir
string
Default: "desc"
Enum: "asc" "desc"
labels
Array of integers <int32> [ items <int32 > ]
page
integer <int32>
Default: 1
page_size
integer <int32>
Default: 10
notifications
boolean

Filter on notifications

seo_issues
boolean

Filter on seo issues

seo_issue_alerts
boolean

Filter on seo issues with classification alert

seo_issue_warnings
boolean

Filter on seo issues with classification warning

seo_issue_infos
boolean

Filter on seo issues with classification info

seo_issue_technicals
boolean

Filter on seo issues with classification technical

spelling_errors
boolean

Filter on spelling errors

confirmed_spelling_errors
boolean

Filter on confirmed spelling errors

potential_spelling_errors
boolean

Filter on potential spelling errors

quality_notifications
boolean

Filter on policy notifications

broken_links
boolean

Filter on broken links

ni_numbers
boolean

Filter on ni numbers

languages
Array of strings

Filter on language(s)

policy_violations
boolean

Filter on policy violations

policy_searches
boolean

Filter on policy searches

policy_required
boolean

Filter on policy required

policy_errors
boolean

Filter on policy violations OR policy required

link_to
string

Filter on pages with link to value

data_protection_violations
boolean

Filter on pages with Data Protection violations

info_type_id
integer <int32>

Filter on pages with Data Protection violations with a given Info Type

data_protection_content_id
integer <int32>

Filter on pages with Data Protection violations with a given Content

data_protection_violation_id
integer <int32>

Filter on pages with a given Data Protection violation

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain_id": 0,
  • "title": "string",
  • "url": "string",
  • "mrank": 0,
  • "hit_score": 0,
  • "link_score": 0,
  • "error_score": 0,
  • "priority_score": 0,
  • "detected_language": "string",
  • "language_override": "string",
  • "no_index": true,
  • "hits": 0,
  • "type": "string",
  • "dead_links_count": 0,
  • "ignored_links_count": 0,
  • "fixed_links_count": 0,
  • "dead_images_count": 0,
  • "ignored_images_count": 0,
  • "fixed_images_count": 0,
  • "seo_issues_count": 0,
  • "spelling_errors_count": 0,
  • "notification_count": 0,
  • "spelling_errors_confirmed_count": 0,
  • "spelling_errors_potential_count": 0,
  • "accessibility_checks_with_errors_count": 0,
  • "accessibility_ignored_checks_count": 0,
  • "nin_count": 0,
  • "quality_notification_count": 0,
  • "words_count": "string",
  • "readability_words_count": "string",
  • "language": "string",
  • "domain": {
    },
  • "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": {
    },
  • "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

Content type
application/json
{
  • "category": "dead_links",
  • "recipients": [
    ],
  • "source_type": "Domain",
  • "source_id": 0,
  • "category_ref": "1"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "source_id": "string",
  • "source_type": "string",
  • "state": "string",
  • "category": "string",
  • "category_ref": "string",
  • "recipients": "string",
  • "data_url": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

getExports

List exports

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

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "source_id": "string",
  • "source_type": "string",
  • "state": "string",
  • "category": "string",
  • "category_ref": "string",
  • "recipients": "string",
  • "data_url": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

getExportsExportId

Get export

path Parameters
export_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "source_id": "string",
  • "source_type": "string",
  • "state": "string",
  • "category": "string",
  • "category_ref": "string",
  • "recipients": "string",
  • "data_url": "string",
  • "created_at": "string",
  • "updated_at": "string"
}

domains

Operations about domains

postDomains

Create domain

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

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "active": true,
  • "scan": {
    },
  • "cms": "sitecore",
  • "features": {
    },
  • "language": "string",
  • "cms_extra": { },
  • "domain_users": [
    ],
  • "path_constraints": [
    ],
  • "link_excludes": [
    ],
  • "accessibility_source_code_excludes": [
    ],
  • "additional_internal_urls": [
    ],
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": {
    },
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "customer_id": 0,
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "cms": 0,
  • "language": "string",
  • "customer": {
    },
  • "last_scan": "string",
  • "crawled_pages": "string",
  • "crawl_status": {
    },
  • "crawl_history": {
    },
  • "domain_users": {
    },
  • "token": "string",
  • "features": {
    },
  • "scan": {
    },
  • "path_constraints": {
    },
  • "link_excludes": {
    },
  • "excluded_ips": "string",
  • "domain_groups": {
    },
  • "running_groups": "string",
  • "accessibility_source_code_excludes": [
    ],
  • "cms_extra": "string",
  • "additional_internal_urls": {
    },
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "favorite": "string",
  • "monsido_script_installed": "string",
  • "labels": {
    }
}

getDomains

List domains

query Parameters
labels
Array of integers <int32> [ items <int32 > ]
page
integer <int32>
Default: 1
page_size
integer <int32>
Default: 10
search
string

Title, url and token search

sort_dir
string
Default: "asc"
Enum: "asc" "desc"
sort_by
string
Default: "title"
Enum: "title" "id" "favorite"
mini
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "customer_id": 0,
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "cms": 0,
  • "language": "string",
  • "customer": {
    },
  • "last_scan": "string",
  • "crawled_pages": "string",
  • "crawl_status": {
    },
  • "crawl_history": {
    },
  • "domain_users": {
    },
  • "token": "string",
  • "features": {
    },
  • "scan": {
    },
  • "path_constraints": {
    },
  • "link_excludes": {
    },
  • "excluded_ips": "string",
  • "domain_groups": {
    },
  • "running_groups": "string",
  • "accessibility_source_code_excludes": [
    ],
  • "cms_extra": "string",
  • "additional_internal_urls": {
    },
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "favorite": "string",
  • "monsido_script_installed": "string",
  • "labels": {
    }
}

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

Content type
application/json
{
  • "callback_url": "string",
  • "on_failure_callback_url": "string",
  • "full_cookie_scan": false
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

getDomainsDomainIdFavicon

Get favicon

path Parameters
domain_id
required
integer <int32>
query Parameters
group_id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

deleteDomainsDomainId

Delete domain

path Parameters
domain_id
required
integer <int32>
query Parameters
group_id
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

patchDomainsDomainId

Update domain

path Parameters
domain_id
required
integer <int32>
query Parameters
group_id
integer <int32>
Request Body schema: application/json
title
string
url
string
timezone
string
active
boolean
object
cms
string
object
language
string
cms_extra
object
Array of objects
Array of objects
Array of objects
accessibility_source_code_excludes
Array of integers <int32> [ items <int32 > ]
Array of objects
excluded_ips
string
object
source_code_excludes
Array of integers <int32> [ items <int32 > ]
object
labels
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "active": true,
  • "scan": {
    },
  • "cms": "string",
  • "features": {
    },
  • "language": "string",
  • "cms_extra": { },
  • "domain_users": [
    ],
  • "path_constraints": [
    ],
  • "link_excludes": [
    ],
  • "accessibility_source_code_excludes": [
    ],
  • "additional_internal_urls": [
    ],
  • "excluded_ips": "string",
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": {
    },
  • "labels": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "customer_id": 0,
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "cms": 0,
  • "language": "string",
  • "customer": {
    },
  • "last_scan": "string",
  • "crawled_pages": "string",
  • "crawl_status": {
    },
  • "crawl_history": {
    },
  • "domain_users": {
    },
  • "token": "string",
  • "features": {
    },
  • "scan": {
    },
  • "path_constraints": {
    },
  • "link_excludes": {
    },
  • "excluded_ips": "string",
  • "domain_groups": {
    },
  • "running_groups": "string",
  • "accessibility_source_code_excludes": [
    ],
  • "cms_extra": "string",
  • "additional_internal_urls": {
    },
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "favorite": "string",
  • "monsido_script_installed": "string",
  • "labels": {
    }
}

getDomainsDomainId

Get domain

path Parameters
domain_id
required
integer <int32>
query Parameters
group_id
integer <int32>
extended
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "customer_id": 0,
  • "title": "string",
  • "url": "string",
  • "timezone": "string",
  • "cms": 0,
  • "language": "string",
  • "customer": {
    },
  • "last_scan": "string",
  • "crawled_pages": "string",
  • "crawl_status": {
    },
  • "crawl_history": {
    },
  • "domain_users": {
    },
  • "token": "string",
  • "features": {
    },
  • "scan": {
    },
  • "path_constraints": {
    },
  • "link_excludes": {
    },
  • "excluded_ips": "string",
  • "domain_groups": {
    },
  • "running_groups": "string",
  • "accessibility_source_code_excludes": [
    ],
  • "cms_extra": "string",
  • "additional_internal_urls": {
    },
  • "page_assist_settings": {
    },
  • "source_code_excludes": [
    ],
  • "settings": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "favorite": "string",
  • "monsido_script_installed": "string",
  • "labels": {
    }
}

getDomainsDomainIdAccessibilityChecks

Get accessibility checks

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "result_type": "string",
  • "tags": [
    ],
  • "difficulty": 0,
  • "impact": "string",
  • "friendly_name": "string",
  • "responsibilities": "string",
  • "labels": {
    },
  • "previous_check_id": "string",
  • "mobile": "string",
  • "errors_count": 0,
  • "comments": {
    },
  • "issue_number": "string",
  • "issue_abbr": "string",
  • "ignored": "string",
  • "pages_count": 0
}

getDomainsDomainIdAccessibilityChecksAccessibilityCheckIdPages

List pages for a accessibility check

path Parameters
accessibility_check_id
required
integer <int32>
domain_id
required
integer <int32>
query Parameters
type
string
Enum: "html" "pdf" "document"

Filter on type

types
Array of strings
Items Enum: "html" "pdf" "document"

Filter on multiple types

search
string

Title and url search

sort_by
string
Default: "title"
Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir
string
Default: "desc"
Enum: "asc" "desc"
labels
Array of integers <int32> [ items <int32 > ]
page
integer <int32>
Default: 1
page_size
integer <int32>
Default: 10
notifications
boolean

Filter on notifications

seo_issues
boolean

Filter on seo issues

seo_issue_alerts
boolean

Filter on seo issues with classification alert

seo_issue_warnings
boolean

Filter on seo issues with classification warning

seo_issue_infos
boolean

Filter on seo issues with classification info

seo_issue_technicals
boolean

Filter on seo issues with classification technical

spelling_errors
boolean

Filter on spelling errors

confirmed_spelling_errors
boolean

Filter on confirmed spelling errors

potential_spelling_errors
boolean

Filter on potential spelling errors

quality_notifications
boolean

Filter on policy notifications

broken_links
boolean

Filter on broken links

ni_numbers
boolean

Filter on ni numbers

languages
Array of strings

Filter on language(s)

policy_violations
boolean

Filter on policy violations

policy_searches
boolean

Filter on policy searches

policy_required
boolean

Filter on policy required

policy_errors
boolean

Filter on policy violations OR policy required

link_to
string

Filter on pages with link to value

data_protection_violations
boolean

Filter on pages with Data Protection violations

info_type_id
integer <int32>

Filter on pages with Data Protection violations with a given Info Type

data_protection_content_id
integer <int32>

Filter on pages with Data Protection violations with a given Content

data_protection_violation_id
integer <int32>

Filter on pages with a given Data Protection violation

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain_id": 0,
  • "title": "string",
  • "url": "string",
  • "mrank": 0,
  • "hit_score": 0,
  • "link_score": 0,
  • "error_score": 0,
  • "priority_score": 0,
  • "detected_language": "string",
  • "language_override": "string",
  • "no_index": true,
  • "hits": 0,
  • "type": "string",
  • "dead_links_count": 0,
  • "ignored_links_count": 0,
  • "fixed_links_count": 0,
  • "dead_images_count": 0,
  • "ignored_images_count": 0,
  • "fixed_images_count": 0,
  • "seo_issues_count": 0,
  • "spelling_errors_count": 0,
  • "notification_count": 0,
  • "spelling_errors_confirmed_count": 0,
  • "spelling_errors_potential_count": 0,
  • "accessibility_checks_with_errors_count": 0,
  • "accessibility_ignored_checks_count": 0,
  • "nin_count": 0,
  • "quality_notification_count": 0,
  • "words_count": "string",
  • "readability_words_count": "string",
  • "language": "string",
  • "domain": {
    },
  • "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": {
    },
  • "data_protection_violations_counts": "string",
  • "error_searches_count": 0,
  • "searches_count": 0,
  • "quality_notifications_not_searches": 0
}

getDomainsDomainIdAccessibilityChecksAccessibilityCheckIdHelp

Get check help information

path Parameters
accessibility_check_id
required
integer <int32>
domain_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "guidelines": "string",
  • "success_criteria": "string",
  • "quick_guide": "string",
  • "short_description": "string",
  • "how_to_repair": "string",
  • "pass_examples": "string",
  • "fail_examples": "string",
  • "others": "string",
  • "html_element": "string",
  • "article_url": "string",
  • "check": "string",
  • "suggestion": "string"
}

patchDomainsDomainIdAccessibilityChecksAccessibilityCheckId

Update accessibility check

path Parameters
accessibility_check_id
required
integer <int32>
domain_id
required
integer <int32>
Request Body schema: application/json
ignored
required
boolean
comment
string

Responses

Request samples

Content type
application/json
{
  • "ignored": true,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "number": "string",
  • "result_type": "string",
  • "tags": [
    ],
  • "difficulty": 0,
  • "impact": "string",
  • "friendly_name": "string",
  • "responsibilities": "string",
  • "labels": {
    },
  • "previous_check_id": "string",
  • "mobile": "string",
  • "errors_count": 0,
  • "comments": {
    }
}

getDomainsDomainIdAccessibilityIgnoredChecksPages

Get pages with ignored accessibility checks

path Parameters
domain_id
required
integer <int32>
query Parameters
type
string
Enum: "html" "pdf" "document"

Filter on type

types
Array of strings
Items Enum: "html" "pdf" "document"

Filter on multiple types

search
string

Title and url search

sort_by
string
Default: "title"
Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir
string
Default: "desc"
Enum: "asc" "desc"
labels
Array of integers <int32> [ items <int32 > ]
page
integer <int32>
Default: 1
page_size
integer <int32>
Default: 10
notifications
boolean

Filter on notifications

seo_issues
boolean

Filter on seo issues

seo_issue_alerts
boolean

Filter on seo issues with classification alert

seo_issue_warnings
boolean

Filter on seo issues with classification warning

seo_issue_infos
boolean

Filter on seo issues with classification info

seo_issue_technicals
boolean

Filter on seo issues with classification technical

spelling_errors
boolean

Filter on spelling errors

confirmed_spelling_errors
boolean

Filter on confirmed spelling errors

potential_spelling_errors
boolean

Filter on potential spelling errors

quality_notifications
boolean

Filter on policy notifications

broken_links
boolean

Filter on broken links

ni_numbers
boolean

Filter on ni numbers

languages
Array of strings

Filter on language(s)

policy_violations
boolean

Filter on policy violations

policy_searches
boolean

Filter on policy searches

policy_required
boolean

Filter on policy required

policy_errors
boolean

Filter on policy violations OR policy required

link_to
string

Filter on pages with link to value

data_protection_violations
boolean

Filter on pages with Data Protection violations

info_type_id
integer <int32>

Filter on pages with Data Protection violations with a given Info Type

data_protection_content_id
integer <int32>

Filter on pages with Data Protection violations with a given Content

data_protection_violation_id
integer <int32>

Filter on pages with a given Data Protection violation

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain_id": 0,
  • "title": "string",
  • "url": "string",
  • "mrank": 0,
  • "hit_score": 0,
  • "link_score": 0,
  • "error_score": 0,
  • "priority_score": 0,
  • "detected_language": "string",
  • "language_override": "string",
  • "no_index": true,
  • "hits": 0,
  • "type": "string",
  • "dead_links_count": 0,
  • "ignored_links_count": 0,
  • "fixed_links_count": 0,
  • "dead_images_count": 0,
  • "ignored_images_count": 0,
  • "fixed_images_count": 0,
  • "seo_issues_count": 0,
  • "spelling_errors_count": 0,
  • "notification_count": 0,
  • "spelling_errors_confirmed_count": 0,
  • "spelling_errors_potential_count": 0,
  • "accessibility_checks_with_errors_count": 0,
  • "accessibility_ignored_checks_count": 0,
  • "nin_count": 0,
  • "quality_notification_count": 0,
  • "words_count": "string",
  • "readability_words_count": "string",
  • "language": "string",
  • "domain": {
    },
  • "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": {
    },
  • "data_protection_violations_counts": "string",
  • "error_searches_count": 0,
  • "searches_count": 0,
  • "quality_notifications_not_searches": 0
}

getDomainsDomainIdAccessibilityPages

List pages

path Parameters
domain_id
required
integer <int32>
query Parameters
type
string
Enum: "html" "pdf" "document"

Filter on type

types
Array of strings
Items Enum: "html" "pdf" "document"

Filter on multiple types

search
string

Title and url search

sort_by
string
Default: "title"
Enum: "url" "title" "hits" "priority_score" "language" "readability" "dead_links_count" "dead_images_count" "spelling_errors_confirmed_count" "spelling_errors_potential_count" "accessibility_checks_with_errors_count" "seo_issues_count" "notification_count" "quality_notification_count" "dead_count" "data_protection_violations_count"
sort_dir
string
Default: "desc"
Enum: "asc" "desc"
labels
Array of integers <int32> [ items <int32 > ]
page
integer <int32>
Default: 1
page_size
integer <int32>
Default: 10
notifications
boolean

Filter on notifications

seo_issues
boolean

Filter on seo issues

seo_issue_alerts
boolean

Filter on seo issues with classification alert

seo_issue_warnings
boolean

Filter on seo issues with classification warning

seo_issue_infos
boolean

Filter on seo issues with classification info

seo_issue_technicals
boolean

Filter on seo issues with classification technical

spelling_errors
boolean

Filter on spelling errors

confirmed_spelling_errors
boolean

Filter on confirmed spelling errors

potential_spelling_errors
boolean

Filter on potential spelling errors

quality_notifications
boolean

Filter on policy notifications

broken_links
boolean

Filter on broken links

ni_numbers
boolean

Filter on ni numbers

languages
Array of strings

Filter on language(s)

policy_violations
boolean

Filter on policy violations

policy_searches
boolean

Filter on policy searches

policy_required
boolean

Filter on policy required

policy_errors
boolean

Filter on policy violations OR policy required

link_to
string

Filter on pages with link to value

data_protection_violations
boolean

Filter on pages with Data Protection violations

info_type_id
integer <int32>

Filter on pages with Data Protection violations with a given Info Type

data_protection_content_id
integer <int32>

Filter on pages with Data Protection violations with a given Content

data_protection_violation_id
integer <int32>

Filter on pages with a given Data Protection violation

abbr
Array of strings
Items Enum: "508" "A" "AA" "AAA"
result_type
Array of strings
Items Enum: "error" "warning" "review"
mobile
boolean

if true, returns only pages containing mobile accessibility errors (may include desktop). if false, returns only pages containing desktop accessibility errors (may include mobile)

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain_id": 0,
  • "title": "string",
  • "url": "string",
  • "mrank": 0,
  • "hit_score": 0,
  • "link_score": 0,
  • "error_score": 0,
  • "priority_score": 0,
  • "detected_language": "string",
  • "language_override": "string",
  • "no_index": true,
  • "hits": 0,
  • "type": "string",
  • "dead_links_count": 0,
  • "ignored_links_count": 0,
  • "fixed_links_count": 0,
  • "dead_images_count": 0,
  • "ignored_images_count": 0,
  • "fixed_images_count": 0,
  • "seo_issues_count": 0,
  • "spelling_errors_count": 0,
  • "notification_count": 0,
  • "spelling_errors_confirmed_count": 0,
  • "spelling_errors_potential_count": 0,
  • "accessibility_checks_with_errors_count": 0,
  • "accessibility_ignored_checks_count": 0,
  • "nin_count": 0,
  • "quality_notification_count": 0,
  • "words_count": "string",
  • "readability_words_count": "string",
  • "language": "string",
  • "domain": {
    },
  • "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": {
    },
  • "data_protection_violations_counts": "string",
  • "error_searches_count": 0,
  • "searches_count": 0,
  • "quality_notifications_not_searches": 0
}

postDomainsDomainIdAccessibilityPdfsClarityRemediation

Request Clarity remediation for all domain PDFs

path Parameters
domain_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

postDomainsDomainIdAccessibilityPdfsClarityReport

Queue all domain PDFs for Clarity ADA report

path Parameters
domain_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

postDomainsDomainIdAccessibilityPdfsReviewAll

Mark all domain PDFs as reviewed

path Parameters
domain_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": "string"
}

getDomainsDomainIdAccessibilityPdfs

List PDF documents

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

Responses

Response samples

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

postDomainsDomainIdAccessibilityPdfsPdfIdClarityRemediation

Request Clarity remediation

path Parameters
pdf_id
required
integer <int32>
domain_id
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "domain_id": 0,
  • "title": "string",
  • "url": "string",
  • "reviewed": true,
  • "content_length": 0,
  • "pages_count": 0,
  • "word_count": 0,
  • "clarity_accessibility_errors_count": 0,
  • "clarity_accessibility_checks_with_errors_count": 0,
  • "clarity_tagged": true,
  • "clarity_queued_at":