Content Search dashboard
The Content Search dashboard provide insights into your Content API search usage, including request volumes, rate limiting, and error metrics.
By default, the dashboard displays data for the past day; however, you can adjust the time range as needed, anywhere from the past 15 minutes to the past three months.
To access the dashboards, navigate to Delivery > Dashboards > Content Search.
Each dashboard contains the following charts:
Requests
The Search Requests bar chart chart visualizes the volume of /search requests made to Content API through your PageBuilder content sources or other applications. This chart includes:
The stacked bar chart displays passed and rate-limited searches for the time period selected. Hover over a bar to view exact request counts.
The yellow horizontal line indicates your Content API rate limit, measured in requests per minute (r/m). Temporary spikes in traffic may cause rate limiting, even if the total requests for that bar “appear” below the rate limit line. This occurs because the bar chart aggregates requests over the selected time range, while rate limiting is enforced per second.
A vertical red line indicates a PageBuilder deployment. Deployments often contain changes to blocks or content sources, which may introduce errors or affect Content API performance.
If you notice frequent rate limiting, consider reducing batch job frequency and adjusting request distribution. For best practices, see Content API Best Practices: Avoid rate limiting and improve performance.
This box shows the current configuration for your rate limit. Note that your rate limit is based on your current paid bandwidth, seats and number of sites.
The Search Requests donut chart displays your total passed and failed requests.
Status codes
The Requests by Status Code bar chart shows the type of error over time, helping you diagnose specific types of errors. Hover over a bar to view exact request counts.
A 429 error showcases where the API was rate limited and matches the rejected status in the Search Requests graph, but there are a number of other errors that appear in this section:
Status Code | Error | Resolution |
|---|---|---|
400 | Content API encountered an issue with the request, indicating an invalid or malformed request. | Ensure the request follows the API definition. |
401 | The request does not contain a valid bearer token. | Ensure the request includes a valid bearer token with the correct permissions. |
404 | The requested content is not in Content API. | Ensure that the content source or your source application is injecting existing Arc UIDs into the requests. |
408 | The request timed out. | This may indicate that the query used is too complex for Content API to handle in a timely manner. Evaluate ways to simplify the request. |
429 | The request was rate limited. | Consider reducing batch job frequency and adjusting request distribution. |
499 | Content API took too long to respond. | This may indicate that the query used is too complex for Content API to handle in a timely manner. Evaluate ways to simplify the request. |
500 | Content API encountered an unexpected condition and couldn't fulfill the request. | No action is required. Retry your request again shortly as the system is expected to recover automatically. |
503 | Content API is unavailable. | No action is required. Retry your request again shortly as the system is expected to recover automatically. |
502 - 504 | Something went wrong during the communication between Arc XP’s internal servers. | No action is required. Retry your request again shortly as the system is expected to recover automatically. |
The Requests by status code donut chart displays the total number of requests for the given time period, indicating how many are having errors as a percent of the total. Hover over a section to view the percentage breakdown by status code.
Headless customers
If you do not use PageBuilder, you may not have the Delivery tile provisioned in your environment. If this is the case, contact Arc XP Customer Support to request this dashboard.