> For the complete documentation index, see [llms.txt](https://docs.aohwv.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aohwv.dev/features/reports.md).

# Reports

CloudSync provides built-in reports to help you understand sync activity, user changes, and system health over time.

## Overview

Reports give you insights into:

* Sync performance and trends
* User provisioning and changes
* Error patterns and resolutions
* Compliance and audit information

## Who This Is For

* Administrators monitoring system health
* Operators tracking sync effectiveness
* Compliance teams needing audit data
* Managers reviewing identity changes

## Prerequisites

* ✅ Logged into CloudSync
* ✅ At least Viewer role (some reports require Operator or Admin)
* ✅ Sync history exists (reports need data)

## Accessing Reports

{% stepper %}
{% step %}

#### Access CloudSync Reports

* Log in to CloudSync
* Click **Reports** in the sidebar
* Select a report type
  {% endstep %}
  {% endstepper %}

***

## Available Reports

### Sync Summary Report

**What it shows:** Overview of sync activity over a time period.

**Includes:**

* Total syncs run
* Success/warning/failure breakdown
* Records processed
* Average sync duration
* Trend over time

**Best for:** Weekly/monthly status updates, management reporting.

***

### User Changes Report

**What it shows:** All user create, update, and delete operations.

**Includes:**

* User name and email
* Change type (created/updated/deleted)
* Changed attributes (before → after)
* Timestamp
* Source sync

**Best for:** Auditing, tracking onboarding/offboarding, change history.

***

### Error Analysis Report

**What it shows:** Error patterns and trends.

**Includes:**

* Error count by type
* Most common errors
* Trend over time
* Affected users list
* Resolution status

**Best for:** Troubleshooting, identifying systemic issues, prioritizing fixes.

***

### Compliance Report

**What it shows:** Audit-ready summary of sync activity and configuration.

**Includes:**

* Configuration summary
* Administrative changes
* User access log
* Data handling summary
* Sync history overview

**Best for:** Audit requests, compliance reviews, security assessments.

***

### Health Report

**What it shows:** System health metrics and performance.

**Includes:**

* Connection status
* Sync success rate
* Average response times
* Error rate trends
* Resource utilization

**Best for:** Performance monitoring, capacity planning, SLA tracking.

***

## Generating a Report

{% stepper %}
{% step %}

#### Select Report Type

* Go to **Reports**
* Click the report you want\
  The report configuration page opens.
  {% endstep %}

{% step %}

#### Configure Parameters

Set the report parameters:

| Parameter           | Options                   | Description              |
| ------------------- | ------------------------- | ------------------------ |
| **Date Range**      | Last 7/30/90 days, custom | Time period to include   |
| **Source System**   | All, or specific          | Which HR system(s)       |
| **Include Details** | Yes/No                    | Summary only or detailed |
| **Group By**        | Day/Week/Month            | Time grouping for trends |
| {% endstep %}       |                           |                          |

{% step %}

#### Generate

* Click **Generate Report**
* Wait for processing (may take a few seconds)
* Report displays on screen
  {% endstep %}

{% step %}

#### Export (Optional)

* Click **Export** (top right of report)
* Choose format:
  * **PDF** — For sharing and archiving
  * **CSV** — For spreadsheet analysis
  * **Excel** — For further manipulation
* Download the file
  {% endstep %}
  {% endstepper %}

***

## Scheduling Reports

Administrators can set up automatic report generation.

### Create a Scheduled Report

{% stepper %}
{% step %}

#### Open Scheduled Reports

* Go to **Reports** → **Scheduled Reports**
* Click **+ New Scheduled Report**
  {% endstep %}

{% step %}

#### Configure Scheduled Report

Configure:

| Setting         | Description                |
| --------------- | -------------------------- |
| **Report Type** | Which report to generate   |
| **Schedule**    | Daily, weekly, or monthly  |
| **Recipients**  | Email addresses to send to |
| **Format**      | PDF or CSV                 |
| {% endstep %}   |                            |

{% step %}

#### Save

* Click **Save**
  {% endstep %}
  {% endstepper %}

### Manage Scheduled Reports

* **Edit** — Click the report name to modify
* **Pause** — Temporarily stop generation
* **Delete** — Remove the schedule

***

## Using Reports Effectively

### For Daily Operations

Check daily:

* Sync Summary (last 24 hours)
* Error Analysis (any new patterns?)

Focus on:

* Failed syncs
* Increasing error counts
* Unusual durations

### For Weekly Reviews

Generate weekly:

* Sync Summary (last 7 days)
* User Changes (who was added/removed?)

Share with:

* IT management
* HR stakeholders

### For Monthly/Quarterly Reporting

Generate monthly:

* Comprehensive Sync Summary
* Compliance Report
* Health Report

Use for:

* Management dashboards
* Compliance evidence
* Performance reviews

### For Audits

Generate on demand:

* Compliance Report (specific date range)
* User Changes (relevant period)
* Administrative activity log

Include:

* Configuration snapshot
* Access control list
* Complete change history

***

## Report Customization

### Filtering Data

Most reports support filtering:

| Filter         | What It Does                             |
| -------------- | ---------------------------------------- |
| **Status**     | Show only errors, warnings, or successes |
| **User/Group** | Focus on specific identities             |
| **Department** | Limit to organizational unit             |
| **Date Range** | Specific time period                     |

### Saving Report Configurations

{% stepper %}
{% step %}

#### Configure Filters

Configure your filters on the report page.
{% endstep %}

{% step %}

#### Save Preset

* Click **Save as Preset**
* Name the preset
  {% endstep %}

{% step %}

#### Reuse Preset

* Reuse later from the **Presets** dropdown
  {% endstep %}
  {% endstepper %}

***

## What You Should See

### Good Health Indicators

| Metric       | Healthy | Warning | Critical |
| ------------ | ------- | ------- | -------- |
| Success Rate | > 99%   | 95-99%  | < 95%    |
| Error Rate   | < 1%    | 1-5%    | > 5%     |
| Avg Duration | Stable  | +20%    | +50%     |

### In the Sync Summary

* Mostly green (successful) bars
* Consistent processing counts
* Stable or improving trends

### In Error Analysis

* Low overall error count
* No single error dominating
* Decreasing trend over time

***

## Troubleshooting

<details>

<summary>Report won't generate</summary>

| Symptom          | Cause              | Solution                           |
| ---------------- | ------------------ | ---------------------------------- |
| Spinning forever | Too much data      | Reduce date range                  |
| "No data"        | No syncs in period | Choose different date range        |
| Error message    | Processing issue   | Retry; contact support if persists |

</details>

<details>

<summary>Report is empty</summary>

| Cause                   | Solution            |
| ----------------------- | ------------------- |
| Date range has no syncs | Expand the range    |
| Filters too restrictive | Remove filters      |
| Wrong source selected   | Check source filter |

</details>

<details>

<summary>Scheduled report not arriving</summary>

| Cause             | Solution                 |
| ----------------- | ------------------------ |
| Email in spam     | Check spam folder        |
| Wrong email       | Verify recipient address |
| Schedule paused   | Check schedule status    |
| Generation failed | Check report logs        |

</details>

***

## Next Steps

* [Monitoring Syncs](/features/monitoring.md) — Real-time monitoring
* [Audit Logs](/administration/audit-logs.md) — Administrative activity

## Related Topics

* [Sync Types](broken://pages/DOz1wWJ0ljdOCk1UTqFr) — Understanding sync operations


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aohwv.dev/features/reports.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
