Skip to content

Operations and analytics reference

reference
8 min readUpdated

Use this page to review operational status and documentation analytics, then choose the appropriate report or follow-up action.

Operations and analytics at a glance

Administrative analytics measures how readers use published documentation. Operations brings together the status information used to review recent documentation work. Use this reference after work has run and before you move to a reporting or administrative follow-up.

If you need to…Go to
Check reader activity, searches, documents, or content gapsReview status and measurements
Check operational loading, errors, jobs, or queuesReview status and measurements
Download analytics or documentation outputExport analytics and schedule reports
Create or maintain an automatic reportExport analytics and schedule reports
Resolve an empty state or failed loadHandle empty states and errors
Read the procedure for administrative operationsAdminister operations
Read the procedure for administrative analyticsAdminister analytics
Understand the analytics workspaceAnalytics overview
Inspect project measurementsRead project analytics
Analytics dashboard controls and empty states

Prerequisites for a useful review

Prerequisites

  • Sign in before opening the analytics or operations route.
  • Select a project before reviewing project analytics. Without a selected project, the page shows Select a project and the message Analytics covers the published docs of one project at a time.
  • Wait for the page to finish loading before interpreting its numbers, tables, or optional areas.

Analytics values, project names, report options based on saved versions, and optional sections depend on the information available to your organization when the page loads.

Open the review surface

Use this procedure when you need to reach the review surface from a saved link, bookmark, or navigation entry.

Prerequisites

  • Sign in.
  • Decide whether you need operational status or project analytics.

Steps

  1. Open the route that matches your task.

    If you need to…Open
    Review operational statusOperations
    Review analytics for the current projectAnalytics
  2. If the analytics page asks you to choose a project, select a project from the project selector in the application header.

Result: The applicable operations or analytics surface is open.

Review status and measurements

Use the selected view to inspect reader activity or current documentation work.

Review analytics

Prerequisites

  • Open Analytics with a selected project.

Steps

  1. Select Dashboard to review the main measurements.

  2. Select the period that answers your question.

    If you need to review…Select
    The most recent week7d
    The most recent 30 days30d
    The most recent 90 days90d
    The most recent year1y
  3. Read Page views, Unique visitors, Avg time on page, Avg scroll depth, Bounce rate, and Searches in the measurement row.

  4. Select Audit Trail to review recorded activity.

  5. In Audit action, select the activity category you need.

    If you need to review…Select
    Every recorded activityAll Actions
  6. Select Needs Attention to review tracked work and reader feedback.

Result: The selected analytics view displays the measurements, lists, or empty state for the chosen period.

Review operational status

Prerequisites

  • Open Operations with a signed-in session.

Steps

  1. Read the statistics at the top of the page.
  2. Review AI spend by model for model, operation, calls, tokens, and cost.
  3. Review Recent jobs for when each job ran, its status, stage, document count, duration, and error.
  4. Review Queues when the section appears.

Result: The operations page displays the current statistics and the available job, model, and queue information.

Export analytics and schedule reports

Use Export Center when you need a file for immediate analysis, a scheduled summary, or a documentation package.

Download an analytics export

Prerequisites

  • Open analytics with a selected project.

Steps

  1. Select Export Center.

  2. In Period, select one of the available periods.

    PeriodMeaning
    Last 7 daysThe most recent seven days
    Last 30 daysThe most recent 30 days; this is the initial choice
    Last 90 daysThe most recent 90 days
    Last yearThe most recent year
  3. In Format, select PDF or CSV.

  4. If you selected CSV, use Table to select Page views or Search queries.

  5. Select Download.

Result: The export request is submitted with the selected period, format, and table.

Create or update a scheduled report

Prerequisites

  • Open Export Center.
  • Have a report name and at least one recipient email address ready.

Steps

  1. In Scheduled reports, select + New report.

  2. In Name, enter the name for the report.

  3. In Frequency, select one option.

    If the report should run…Select
    Every dayDaily
    Every weekWeekly; this is the initial choice
    Every monthMonthly
  4. In Time (UTC), select one of the hourly choices from 00:00 through 23:00. The initial choice is 09:00.

  5. If Frequency is Weekly, select a Day of week from Monday through Sunday. The initial choice is Monday.

  6. If Frequency is Monthly, select a Day of month from 1 through 28. The initial choice is 1.

  7. In Format, select PDF or CSV. The initial choice is PDF.

  8. In Period (days), select 7, 30, or 90. The initial choice is 30.

Result: The scheduled-report form contains the report name, schedule, format, period, and recipient area.

Finish a scheduled report

Prerequisites

  • The scheduled-report form is open, or an existing report is listed.

Steps

  1. In Recipients (comma or space separated), enter at least one recipient email address.

  2. Select Create report for a new report.

  3. For an existing report, choose the action that matches your goal.

    If you need to…Select and then…
    Update the reportSelect Edit. Update the report name, schedule, or recipient list as needed. Select Save changes.
    Run the reportSelect Run now.
    Remove the reportSelect Delete.

Result: A successful new report shows Scheduled report created. A successful edit shows Scheduled report updated. A successful removal shows Scheduled report deleted.

Download documentation

Prerequisites

  • Open Export Center.
  • Have at least one documentation version available.

Steps

  1. In Documentation Exports, select the documentation version.

    If the version list contains…The choice appears as…
    A version numberVersion followed by the version number
    A name but no version numberVersion followed by the name
    Neither a version number nor a nameVersion followed by the first six characters of the ID
    No returned versionsNo versions
  2. Select Download .zip under Markdown Archive for an MDX ZIP archive.

  3. Select Download .zip under Static HTML Site for an offline HTML site.

  4. Under PDF Document, select or clear Table of Contents.

  5. Under PDF Document, select or clear Cover Page.

  6. Under PDF Document, select A4 or Letter.

  7. Select Generate PDF.

Result: The selected documentation export is submitted in the chosen format.

Handle empty states and errors

Use the message on screen to choose the next action. The same surface can show a loading state, an empty state, or an error depending on the data available when it opens.

What you seeWhat it meansWhat to do
Select a projectNo project is selected for analyticsSelect a project in the application header.
Analytics covers the published docs of one project at a time.Analytics is scoped to one projectSelect the project whose published documentation you need to review.
Analytics couldn't be loaded.The analytics request failedSelect Retry.
No audit eventsThe current audit filter has no eventsChange the Audit action filter or wait for an event matching it.
Nothing recorded for this filter yet.No event matches the current filterChange the filter and review the audit list again.
Loading audit events…Audit results are still loadingWait for the audit list to finish loading.
Please enter a name for the reportThe report name is blankEnter a name in Name.
Please add at least one recipient emailNo recipient address was enteredEnter an address in Recipients (comma or space separated).
Update failedA task update did not completeReview the task and submit the update again.
Failed to export audit logThe audit export did not completeRetry the export from Export CSV or Export JSON.
No scheduled reports yet. Create one to receive automatic email summaries.No scheduled report existsSelect + New report.
No exports yetNo export history is availableUse Download or one of the documentation export controls.
No feedback yetNo reader ratings are availableReview the dashboard again after published documentation receives ratings.
Loading operations…Operational data is still loadingWait for the operations page to finish loading.
Operations failed to load.The operations request failedOpen the operations route again.

If you remain on the sign-in form after submitting credentials, check the sign-in details and whether the service is reachable.

Continue from the review

Use the result of the review to choose the next page:

After the review, you need to…Continue with
Understand the Operations hubOperations overview
Administer operational monitoringAdminister operations
Understand the analytics workspaceAnalytics overview
Inspect project analyticsRead project analytics
Review analytics sections and exportsAnalytics reference
Review completed operational workJob History
Review documentation job statusesDocumentation job status reference
Resolve a general application errorGeneral error messages

The review ends with the selected measurement, status, export, or report result on screen. The linked page owns the next task when the next action changes configuration or operational work.

Was this page helpful?

Download as PDF
Operations and analytics reference — Atloria (self dogfood)