See this description of some of the specific data:
Active: Whether it is currently active or not
Id: An id for the specific domain
Customer_id: the id of the customer the domain belongs to
Url: The url for the specific domain
Timezone: example “Europe/Copenhagen"
Cms: Which CMS system is used, or if no cms is used "no_cms"
Language: example "en_US"
Crawl_status: An object describing the ongoing crawl. Or null if no crawl is in progress
Crawl_history: An object containing information about the last crawl of the domain, it contains counts of all the different issues the domain might contain
Features: An object containing which features the domain has (cookie-banner, page-assist, and statistics for example) as well as the domain’s desired reading level, and which WCAG standard it is trying to follow.
Scan: An object containing all the scan settings, including what to ignore or pay attention to, as well as when and how often it should occur
Created_at: When the domain was created in Web Governance
Updated_at: When it was last updated
Domain groups
Domain groups can group several domain pages together. A domain with a lot of pages can sometimes be split into individual domain groups so that each group can be scanned independently from each other. Another option is to assign a subset with scanning rules applied.
Create a new domain group with a set of rules to group certain pages together.
For more information and to find all of the options to create new domain group,
This section contains a list of some useful data from the page resource described:
id: The id for the page
domain_id: The id for the pages domain
Title: Title for the page
Url: URL for the page
Cms_url: URL for the pages associated CMS service
Domain: An object holding data from the pages domain, for example its id, customer id, whether it’s active, and so on. It will match the domain described above.
Lastcheck: The last time the page was scanned/crawled, for example "2022-10-26T10:04:33.952Z"
latest_page_scan_status: "string"
created_at: When the page was created.
Updated_at: When it was last updated.
There are also several data points that describe the amount of errors and issues.
Versioning
For the option to add future features in our API without removing functionality, Web Governance can relegate the API into different versions. Currently we only have a single version named “v1”
Should we wish to drastically change our API and/or remove features, we would make a new version, with the previous ones remaining available.
The HTTP Request
HTTP request methods
These are all of the possible request methods in use by Web Governance. Note that not all endpoints take all methods.
Request Method
Description
Get
Get one or many resources
Post
Create a new resource
Put
Replace a resource
Patch
Update a resource
Delete
Destroy a resource
Headers
Required headers
Authorization - Bearer token, see (How to make api users)
Host - The domain name of the server.
Optional headers
Accept-Version - Which version of the API to use. Currently only v1 is available.
Web Governance-Account-Id - To make the request using a specific account.
Params
Parameters that can be included when making a request. Some parameters are available on multiple endpoints while others are specific to the individual endpoints.
Pagination
To limit the amount of resources returned, Web Governance uses pagination for many endpoints.
The types which can be included in a search depend on the endpoint but can be used to find specific resources. A specific page using its title or url, for example, can look like this:
If something goes wrong, you might get an error back which could look like this:
Code: 401
cache-control: no-cache
content-type: application/json
{
"message": "The Authorization header is missing"
}
Asynchronous actions
Many parts of our application run processes asynchronously, such as report generation, scanning pages, crawling domains, and updating counters.
To keep track of these, view the ‘Notifications’ endpoint.
Notifications
Notifications return an array of all the notifications our system generates pertaining to your account. Whenever an action is taken that happens asynchronously, you will need to be notified about when it is completed. Examples are when a crawl completes or a cookie scan is finished.
You can get notifications periodically to check when some actions have been completed. Refer to the Get notifications endpoint for more information:
When getting the results, many of our endpoints often contain numbers which are pre-calculated ahead of time. This speeds up the requests. Affected requests include the amount of error types that exist and the amount of errors on specific checks, among other things. These very rarely need to be changed.
These cached numbers are updated automatically whenever such changes are necessary.
Introduction to Acquia Web Governance API
This document provides instructions on how to make advanced API settings.
Specify which API to use
Web Governance has four APIs that handle different geographical parts of the world.
See this description of some of the specific data:
Active: Whether it is currently active or not
Id: An id for the specific domain
Customer_id: the id of the customer the domain belongs to
Url: The url for the specific domain
Timezone: example “Europe/Copenhagen"
Cms: Which CMS system is used, or if no cms is used "no_cms"
Language: example "en_US"
Crawl_status: An object describing the ongoing crawl. Or null if no crawl is in progress
Crawl_history: An object containing information about the last crawl of the domain, it contains counts of all the different issues the domain might contain
Features: An object containing which features the domain has (cookie-banner, page-assist, and statistics for example) as well as the domain’s desired reading level, and which WCAG standard it is trying to follow.
Scan: An object containing all the scan settings, including what to ignore or pay attention to, as well as when and how often it should occur
Created_at: When the domain was created in Web Governance
Updated_at: When it was last updated
Domain groups
Domain groups can group several domain pages together. A domain with a lot of pages can sometimes be split into individual domain groups so that each group can be scanned independently from each other. Another option is to assign a subset with scanning rules applied.
Create a new domain group with a set of rules to group certain pages together.
For more information and to find all of the options to create new domain group,
This section contains a list of some useful data from the page resource described:
id: The id for the page
domain_id: The id for the pages domain
Title: Title for the page
Url: URL for the page
Cms_url: URL for the pages associated CMS service
Domain: An object holding data from the pages domain, for example its id, customer id, whether it’s active, and so on. It will match the domain described above.
Lastcheck: The last time the page was scanned/crawled, for example "2022-10-26T10:04:33.952Z"
latest_page_scan_status: "string"
created_at: When the page was created.
Updated_at: When it was last updated.
There are also several data points that describe the amount of errors and issues.
Versioning
For the option to add future features in our API without removing functionality, Web Governance can relegate the API into different versions. Currently we only have a single version named “v1”
Should we wish to drastically change our API and/or remove features, we would make a new version, with the previous ones remaining available.
The HTTP Request
HTTP request methods
These are all of the possible request methods in use by Web Governance. Note that not all endpoints take all methods.
Request Method
Description
Get
Get one or many resources
Post
Create a new resource
Put
Replace a resource
Patch
Update a resource
Delete
Destroy a resource
Headers
Required headers
Authorization - Bearer token, see (How to make api users)
Host - The domain name of the server.
Optional headers
Accept-Version - Which version of the API to use. Currently only v1 is available.
Web Governance-Account-Id - To make the request using a specific account.
Params
Parameters that can be included when making a request. Some parameters are available on multiple endpoints while others are specific to the individual endpoints.
Pagination
To limit the amount of resources returned, Web Governance uses pagination for many endpoints.
The types which can be included in a search depend on the endpoint but can be used to find specific resources. A specific page using its title or url, for example, can look like this:
If something goes wrong, you might get an error back which could look like this:
Code: 401
cache-control: no-cache
content-type: application/json
{
"message": "The Authorization header is missing"
}
Asynchronous actions
Many parts of our application run processes asynchronously, such as report generation, scanning pages, crawling domains, and updating counters.
To keep track of these, view the ‘Notifications’ endpoint.
Notifications
Notifications return an array of all the notifications our system generates pertaining to your account. Whenever an action is taken that happens asynchronously, you will need to be notified about when it is completed. Examples are when a crawl completes or a cookie scan is finished.
You can get notifications periodically to check when some actions have been completed. Refer to the Get notifications endpoint for more information:
When getting the results, many of our endpoints often contain numbers which are pre-calculated ahead of time. This speeds up the requests. Affected requests include the amount of error types that exist and the amount of errors on specific checks, among other things. These very rarely need to be changed.
These cached numbers are updated automatically whenever such changes are necessary.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Did not find what you were looking for?
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Web Governance