The Acquia Optimize API manages the Acquia Optimize platform. It manages
users, their domains, subdomains, their issues, and more.
Acquia Optimize utilizes a restful API. REST is the abbreviation for Representational State Transfer.
It exposes several endpoints, which typically allows a user to use a ‘Get’ command for one or many resources, as well as Post, Patch, Put or Delete resources from our databases. All of those resources are JSON.
Please refer to the following article in the Acquia Optimize Documentation for instructions on how to create Acquia Optimize API users:
Acquia Optimize has 4 APIs that handle different geographical parts of the world.
You should use the API for your region.
EU https://app1.eu.monsido.com/api/
USA https://app1.us.monsido.com/api/
USA https://app2.us.monsido.com/api/
Australia https://app1.au.monsido.com/api/
The Acquia Optimize architecture has a hierarchy composed of interactions between different models. First in the chain is a User who can log in.
Afterwards are Agreements, which tie together 1 User and 1 Account.
There can be multiple Agreements tied to the same user.
The user is tied to one or multiple Accounts.
An account is comprised of settings that pertain to how reports should be delivered, as well as which Domains should be available.
Some endpoints are only useful if specific plans are enabled.
The following endpoints can’t be used unless their corresponding modules are activated for the account:
With the Get Domain endpoint, there is a variety of useful data that can be looked at.
For an example of all of the data that is returned, refer to the Get Domain endpoint:
See this description of some of the specific data:
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,
refer to the Post DomainGroup endpoint:
For example, if there is a domain with several help pages that need to be grouped together, make a post request to: https://app1.eu.monsido.com/api/domains/{domain_id}/domain_groups
Here is an example of how the body should look:
{
"title": "help pages",
"description": "group consisting of our help pages",
"rules": [
{
"match": "url",
"match_rule": "contains",
"exclude": false,
"text": "help"
}
],
"domain_group_members": [
{
"visible": true,
"send_report": true,
"user_id": {user_id},
}
]
}
This section contains a list of some useful data from the page resource described:
There are also several data points that describe the amount of errors and issues.
For the option to add future features in our API without removing functionality, Acquia Optimize 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.
These are all of the possible request methods in use by Acquia Optimize. 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 |
Parameters that can be included when making a request. Some parameters are available on multiple endpoints while others are specific to the individual endpoints.
To limit the amount of resources returned, Acquia Optimize uses pagination for many endpoints.
An example of the domains endpoint:
https://app1.eu.monsido.com/api/domains?page=1&page_size=10
Multiple endpoints include options for sorting:
An example of the Policies endpoint:
https://app1.eu.monsido.com/api/policies?sort-dir=asc&sort-by=name
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:
https://app1.eu.monsido.com/api/pages?search=mySite
A status code is a number, or code, that describes the status of a request.
| Status codes | Description |
| 200 ok | Success getting a response |
| 201 created | Successful creation |
| 202 accepted | Request was accepted. Used when another process handles the supplied data later |
| 204 no content | There is no content for this request |
| 404 content not found | The resource you’re looking for doesn’t exist |
| 403 forbidden | |
| 401 unauthorized | 401 unauthorized, is similar to 403 forbidden. The difference lies in that one can be allowed access upon authorization. |
| 422 unprocessable entity | There is a semantic error |
| 500 internal server error | Something is wrong with the Acquia Optimize server |
These headers are returned by many endpoints:
The response contains a status code and its body will be a JSON object.
It might look something like this:
Code: 200
cache-control: no-cache
content-type: application/json
{
"id": 0,
"domain_id": 0,
"title": "string",
"url": "string",
}
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"
}
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 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.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Wed Nov 13 2024 08:10:08 GMT+0000 (Coordinated Universal Time)