π What this article covers
This guide explains how to identify an existing Site Audit, authenticate an API request, retrieve audit data, revise an OTTO image-alt rule, and confirm that the change was delivered.
π API access and authentication
Use the API key generated in your Search Atlas account. Send it in the X-API-KEY header and include an Accept: application/json header. **
Keep the token private. Do not place it in browser code, public repositories, or shared screenshots.
π Find the audit identifier
** Use the numeric ID of the existing Site Audit projectβnot a domain, OTTO rule ID, or unrelated project ID. You can obtain the audit ID from the Site Audit APIβs list response and use it in the audit detail request.
π‘ Read an existing audit
Use the supported read endpoint:
GET https://ca.searchatlas.com/api/v2/site-audit/{audit_id}/ **
Replace {audit_id} with the audit identifier. Example:
curl --request GET 'https://ca.searchatlas.com/api/v2/site-audit/AUDIT_ID/' --header 'X-API-KEY: YOUR_API_KEY' --header 'Accept: application/json' **
** A successful response returns the audit record and available overview data; detailed results may require other endpoints. An invalid API key can produce an authentication error. A 404 can mean the audit ID is incorrect, archived, or unavailable to the current account. Check the response body and authentication method when troubleshooting.
βοΈ Revise an existing OTTO image rule
To change text for an image-alt rule that has already been deployed, open the relevant project in Search Atlas and go to OTTO. Open the image-alt recommendation or rule, edit the proposed text, and save the revision.
** Edit the existing image-alt recommendation rather than creating a duplicate for the same image. After saving, check its deployment state and verify the result on the live page.
π Publish the revised text
- Open the saved image-alt rule.
- Review the revised text and confirm that it accurately describes the image.
- Select the publish or deploy action shown for the rule.
- ** Use the itemβs Deploy control if it is not already deployed, and follow any instructions shown in the interface.
- Wait until the item shows as Deployed (it appears under the Deployed filter). **
** OTTOβs pixel must be installed and engaged for pixel-delivered changes to appear on the site. Saving an undeployed recommendation does not by itself deploy it. If the image is already deployed, saving an edit can update the deployed modification; verify the live result.
β Verify delivery
- ** Check that the image recommendation is marked Deployed, then verify the revised text on the live page.
- ** Check the saved recommendation and its Deployed state, then inspect the live image to confirm that the revised text appears.
- ** Open the live page with OTTO active, inspect the image element in your browserβs developer tools, and confirm that its alt attribute contains the revised text.
- If the page uses caching, purge or refresh the relevant cache before checking again.
- Run a fresh audit after the change is live if you need the audit results to reflect the new page content.
π οΈ Troubleshoot common issues
- Old text remains: Confirm that the revised rule was published, then check the live page rather than only the OTTO preview.
- Rule is queued: Allow the deployment to finish and check its activity history for an error.
- Page was not changed: Verify that OTTO is installed on the correct site and that the page is included in the project scope.
- API request fails: Check the audit ID, token, Authorization header, and workspace permissions.
If you need further assistance, open the chat widget in the bottom-right corner of the platform and send your message. A member of our support team will reply in the chat.