---
title: "List report history"
source_url: https://dev.digicert.com/certcentral-apis/report-library-api/list-report-history.html
api_method: GET
api_endpoint: "/reports/v1/report/history"
api_url: "https://api.digicert.com/reports/v1/report/history"
---

**GET** `https://api.digicert.com/reports/v1/report/history`

Use this endpoint to get details about scheduled reports and individual report runs.

## Example requests and responses

## cURL

```
curl --request GET 'https://api.digicert.com/reports/v1/report/history' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
```

## 200 OK

```
{
    "page": {
        "total": 1,
        "limit": 1,
        "offset": 0
    },
    "report_history": [
        {
            "report_display_name": "Example Report",
            "report_identifier": "00000000-0000-0000-0000-000000000000",
            "report_run_identifier": "11111111-1111-1111-1111-11111111",
            "created_by_user_id": 12345,
            "created_by_user_name": "John Doe",
            "created_date": "2021-01-13 02:15:48",
            "report_type": "orders",
            "report_type_display_name": "Orders",
            "report_start_date": "2021-01-13 09:15:37",
            "report_end_date": "2021-01-13 09:15:48",
            "schedule": "WEEKLY", 
            "format": [
                "CSV"
            ],
            "status": "READY",
            "manually_triggered": false,
            "split_report_count": 0
        }
    ]
}
```

## URL query parameters

You can filter, sort, and paginate the results for this endpoint by using URL query strings.

To use multiple filters, append the query string for each filter to your request. For example, the filters in this request limit the results to order reports that run on a monthly schedule:

```
https://api.digicert.com/reports/v1/report/history?report_type=orders&schedule=MONTHLY
```

To create a filter that accepts multiple values, provide a comma-separated list of each value that meets your filter criteria. For example, the filters in this request limit the results to reports with:

- A display name of `test` or `example`.
- A status of `FAILED` or `READY`.

```
https://api.digicert.com/reports/v1/report/history?report_display_name=test,example&status=FAILED,READY
```

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>offset</td>
<td>optional</td>
<td>integer</td>
<td>Zero-based offset index for the first record to include in the response. Must be greater than or equal to 0.<br><strong>Default:</strong><code>0</code></td>
</tr>
<tr>
<td>limit</td>
<td>optional</td>
<td>integer</td>
<td>Number of records to include in the response. Must be a positive integer.<br><strong>Default:</strong><code>100</code></td>
</tr>
<tr>
<td>report_display_name</td>
<td>optional</td>
<td>string</td>
<td>Filters results by report display name.</td>
</tr>
<tr>
<td>schedule</td>
<td>optional</td>
<td>string</td>
<td>Filters results by report schedule.<br><strong>Possible values:</strong> <code>ON_DEMAND</code>, <code>WEEKLY</code>, <code>MONTHLY</code></td>
</tr>
<tr>
<td>status</td>
<td>optional</td>
<td>string</td>
<td>Filters results by report status.<br><strong>Possible values:</strong><br><ul><li><code>SCHEDULED</code> - Report is active.</li><li><code>GENERATING</code> - Report run is in progress.</li><li><code>READY</code> - Report run is complete and results are ready for download.</li><li><code>FAILED</code> - Report run failed.</li></ul></td>
</tr>
<tr>
<td>report_type</td>
<td>optional</td>
<td>string</td>
<td>Filters results by report type.<br><strong>Possible values:</strong> See <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-report-types.md">List report types</a>.</td>
</tr>
<tr>
<td>report_type_display_name</td>
<td>optional</td>
<td>string</td>
<td>Filters results by report type display name.</td>
</tr>
<tr>
<td>search</td>
<td>optional</td>
<td>string</td>
<td>Searches reports by display name. The response includes reports with a <code>report_display_name</code> value that is an exact or partial match to the searched value.<br>For example, searching for the string <code>example</code> returns reports with any of these display names: <code>example_test</code>, <code>test_example</code>, or <code>example</code> on its own.</td>
</tr>
<tr>
<td>sort_by</td>
<td>optional</td>
<td>string</td>
<td>Parameter by which to sort results.<br><strong>Possible values:</strong><br><ul><li><code>report_display_name</code></li><li><code>report_type</code></li><li><code>schedule</code></li><li><code>format</code></li></ul><br><strong>Default:</strong><code>report_start_date</code></td>
</tr>
<tr>
<td>sort_direction</td>
<td>optional</td>
<td>string</td>
<td>Sort direction. Use <code>ASC</code> (0-9, A-Z) or <code>DESC</code> (9-0, Z-A).<br><strong>Default:</strong> <code>ASC</code>, unless both <code>sort_by</code> and <code>sort_direction</code> are empty. In this case, results are sorted in <code>DESC</code> order by <code>report_start_date</code> (the default option for the <code>sort_by</code> parameter).</td>
</tr>
<tr>
<td>language_id</td>
<td>optional</td>
<td>integer</td>
<td>ID of the language to use for the string returned in the <code>report_type_display_name</code> field<br><strong>Allowed values:</strong> See <a href="https://dev.digicert.com/md/certcentral-apis/services-api/glossary.md#locale-codes">Glossary - Locale codes</a><br><strong>Default:</strong> English (<code>1</code>)</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>page</td>
<td>object</td>
<td>Object with pagination details.</td>
</tr>
<tr>
<td>.. total</td>
<td>integer</td>
<td>Total number of reports.</td>
</tr>
<tr>
<td>.. limit</td>
<td>integer</td>
<td>Number of reports in the results.</td>
</tr>
<tr>
<td>.. offset</td>
<td>integer</td>
<td>Zero-based offset index of the first record in the results.</td>
</tr>
<tr>
<td>report_history</td>
<td>array of objects</td>
<td>List of objects. Each object contains details for a scheduled report or an individual report run.</td>
</tr>
<tr>
<td>.. report_display_name</td>
<td>string</td>
<td>Report display name.</td>
</tr>
<tr>
<td>.. report_identifier</td>
<td>string</td>
<td>Report ID (UUID).</td>
</tr>
<tr>
<td>.. report_run_identifier</td>
<td>string</td>
<td>Report run ID (UUID). If the <code>report_run_identifier</code> parameter returns an empty string, the object represents a scheduled report instead of an individual report run.</td>
</tr>
<tr>
<td>.. created_by_user_id</td>
<td>string</td>
<td>ID of the user that created the report.</td>
</tr>
<tr>
<td>.. created_date</td>
<td>string</td>
<td>Report creation date and timestamp in UTC.<br><strong>Format:</strong><code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>.. created_by_user_name</td>
<td>string</td>
<td>Username of the user that created the report.</td>
</tr>
<tr>
<td>.. report_type</td>
<td>string</td>
<td>Report type.<br><strong>Possible values:</strong> See <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-report-types.md">List report types</a>.</td>
</tr>
<tr>
<td>.. report_type_display_name</td>
<td>string</td>
<td>Report type display name. To get this value in a language other than English, use the <code>language_id</code> query parameter.</td>
</tr>
<tr>
<td>.. report_start_date</td>
<td>string</td>
<td>For individual report runs, the date and time (UTC) the report run started.<br><strong>Format:</strong><code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>.. report_end_date</td>
<td>string</td>
<td>Date and time (UTC) the report run finished. Only returned for completed report runs (<code>status = READY</code>).<br><strong>Format:</strong><code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>.. schedule</td>
<td>string</td>
<td>Frequency of report creation.<br><strong>Possible values:</strong> <code>ON_DEMAND</code>, <code>WEEKLY</code>, <code>MONTHLY</code></td>
</tr>
<tr>
<td>.. format</td>
<td>array of strings</td>
<td>List of filetype formats in which you can download the results of a report run.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Report status.<br><strong>Possible values:</strong> <code>GENERATING</code>, <code>READY</code>, <code>FAILED</code>, <code>SCHEDULED</code></td>
</tr>
<tr>
<td>data_from_date</td>
<td>string</td>
<td>For scheduled report runs, the start date and time (UTC) of the report's data range.<br><strong>Format:</strong><code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>data_to_date</td>
<td>string</td>
<td>For scheduled report runs, the end date and time (UTC) of the report's data range.<br><strong>Format:</strong><code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>.. manually_triggered</td>
<td>boolean</td>
<td>If true, a user initiated this report run manually by submitting an API request or using the CertCentral console. Otherwise, the report library service initiated the report run automatically, in accordance with the report's schedule.</td>
</tr>
<tr>
<td>.. split_report_count</td>
<td>integer</td>
<td>Number of files the report run is split into. For report runs that do not exceed the maximum number of rows per file, returns <code>0</code>.</td>
</tr>
</tbody>
</table>