# Viewing the service sync report

## Accessing the sync report

To access the latest sync report for your Patchworks services, select **sync reports** from the left-hand navigation bar:\ <img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/NDzAcGBCqYQahY3AcE3I/view%20sync%20report%201.png" alt="" data-size="original">

...the **sync reports** page is displayed:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/we0q5AzmyTOVuK7E3crr/sync%20reports%20no%20annotations.png" alt=""><figcaption></figcaption></figure>

## Understanding the sync report

Each time a Patchworks service runs, it is attempting to sync data between source and destination connectors. When this happens, an entry is added to the **sync report** so you can see - at a glance - every item that has been synced and the outcome (i.e. status) of that operation. The example below highlights key features of this report:

<figure><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/Xppuxz4i3NBAXF6kLVEB/sync%20reports%20main.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
By default, reports are shown for the last 5 days. You can use the [**date/time (UTC)** filter option](#user-content-fn-1)[^1] to increase this number up to a maximum of 15 days.
{% endhint %}

Items to note are summarised below:

<table><thead><tr><th width="96">Ref</th><th width="230">Function</th><th>Summary</th></tr></thead><tbody><tr><td>1</td><td>Report entries</td><td>The main part of the display area shows rows of report entries - you will find one entry for every attempted sync (i.e. one entry for each item synced, irrespective of whether the sync was successful).</td></tr><tr><td>2</td><td>Ellipses actions</td><td>Click the ellipses to access actions that can be taken for current selections - for example, you can <strong>download as CSV</strong>:<br><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/FeVQSy2Nh0QGCPEIIS1X/download%20csv.png" alt=""><br>The download will include all sync report entries matching the currently defined filters.</td></tr><tr><td>3</td><td>Additional filters</td><td><p>Click the <strong>additional filters</strong> option to access options for displaying more information:<br><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/oha8jUImCpAPXgKilz2b/additional%20filters.png" alt="">         <br><br>Here:</p><ul><li>the <strong>show additional sync data</strong> option adds a <strong>latest sync information</strong> column to the table</li><li>the <strong>show additional fields</strong> option adds <strong>source</strong> and <strong>endpoint id</strong> fields (relating to source and destination connectors)</li></ul><p>This extra information is only likely to be required by Patchworks support, in the event of a sync query.<br>                                                                                                                                                                                                                                                </p></td></tr><tr><td>4</td><td>Search</td><td><p>Search for specific sync reports based on:</p><ul><li><strong>system</strong> (e.g. Shopify)</li><li><strong>sync id</strong> (e.g. 12345678)</li><li><strong>Reference</strong> (e.g. DEMOTEST-SS-YELLOW)</li></ul></td></tr><tr><td>5</td><td>Filters</td><td>Click the filter icon associated with a table heading to access associated filter options - for example:<br><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/c9Gue2pCXPgEk1TqotxU/filter%20journey%20.png" alt=""></td></tr><tr><td>6</td><td>Sort report</td><td>Use checkboxes to select specific entries for an action - typically, a resync. You can select a single entry or multiple entries and then choose a mass action.</td></tr><tr><td>7 &#x26; 8</td><td>Select entries/entry for further action</td><td>You can select all or individual report entries and then click the <strong>ellipses actions</strong> option to choose an action to perform - for example:<br><img src="https://content.gitbook.com/content/5mpqoXPMbUuPa8JpCLWe/blobs/Gpf42ZMm19ka6yMDQvWk/multi%20select.png" alt=""></td></tr><tr><td>9</td><td>Sync status</td><td>Every sync report entry has an associated <strong>status</strong>, so you can see whether or not the sync succeeded. For further information please see the <a href="https://doc.wearepatchworks.com/dashboard/reporting-and-logging/sync-reports/viewing-the-sync-report#sync-report-status-indicators">sync status indicators</a> section.</td></tr></tbody></table>

## Sync report status indicators

Every sync report entry has an associated **status**, so you can see whether or not the sync succeeded. As you scan down a report, you may encounter the following status indicators:

<table><thead><tr><th width="259">Status indicator</th><th></th></tr></thead><tbody><tr><td>OK</td><td>Source data has synced to the destination system successfully.</td></tr><tr><td>Sent</td><td>Typically applied for SFTP or file-based services where source data files are pushed to a destination endpoint successfully. <br><br>If the destination endpoint confirms that the data is received, the <strong>sent</strong> status is updated to <strong>OK</strong>.</td></tr><tr><td>Pending</td><td>Source data has been pushed but has not yet reached the destination system. The most common reason for this status is where the destination endpoint is down.<br><br>Typically, a <strong>pending</strong> entry will be retried up to four times before being set to <strong>failed</strong>. The number of retries may vary, depending on how the service is configured. </td></tr><tr><td>Failed</td><td>Sync failures may occur for a number of reasons - for example, if a mapped field in the source/destination system has changed unexpectedly, or if there was a communication issue when the service ran. Please see <a href="handling-failed-service-syncs">Handling a failed sync</a> for further information about managing these cases.</td></tr></tbody></table>

[^1]: See item 5 in the table below.
