---
title: "Report details"
source_url: https://dev.digicert.com/certcentral-apis/report-library-api/report-details.html
api_method: GET
api_endpoint: "/reports/v1/report/{{report_identifier}}"
api_url: "https://api.digicert.com/reports/v1/report/{{report_identifier}}"
---

**GET** `https://api.digicert.com/reports/v1/report/{{report_identifier}}`

Use this endpoint to return information about a report.

## Example requests and responses

## cURL

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

## 200 OK

```
{
  "report": {
    "report_display_name": "Example Report",
    "report_identifier": "00000000-0000-0000-0000-000000000000",
    "created_by_user_id": 12345,
    "created_by_user_name": "John Doe",
    "created_date": "2021-02-18 20:16:53",
    "report_metadata": {
      "report_type": "orders",
      "columns": [
        {
          "identifier": "order_id"
        },
        {
          "identifier": "order_status"
        },
        {
          "identifier": "account_id"
        },
        {
          "identifier": "request_state"
        },
        {
          "identifier": "product_name"
        },
        {
          "identifier": "order_created_date"
        },
        {
          "identifier": "additional_email"
        },
        {
          "identifier": "user_or_requester_name"
        },
        {
          "identifier": "user_or_requester_email"
        },
        {
          "identifier": "common_name"
        },
        {
          "identifier": "sans"
        },
        {
          "identifier": "certificate_status"
        },
        {
          "identifier": "validity_start_date"
        },
        {
          "identifier": "validity_end_date"
        },
        {
          "identifier": "serial_number"
        },
        {
          "identifier": "organization_name"
        }
      ],
      "filters": [
        {
          "filter_identifier": "custom_date",
          "column_identifier": "order_created_date",
          "values": [
            "2021-08-01",
            "2021-08-20"
          ]
        }
      ],
      "sources": {
        "division_filter_type": "INCLUDE_ALL_DIVISIONS",
        "sub_account_filter_type": "EXCLUDE_ALL_SUB_ACCOUNTS",
        "sub_accounts": null,
        "divisions": null
      }
    },
    "schedule": {
      "frequency": "MONTHLY",
      "weekday_to_run": "MONDAY",
      "weekday_frequency": "FIRST",
      "run_until": "",
      "repeat_every": 1,
      "repeat_on": "DAY_OF_THE_MONTH",
      "repeat_on_date": {
        "date": 0,
        "last_day_of_the_month": false
      }
    },
    "next_run_date": "2021-09-06",
    "format": [
      "CSV"
    ],
    "status": "ACTIVE",
    "notification_emails": null
  }
}
```

## Path parameters

<table>
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>report_identifier</td>
<td>required</td>
<td>Report ID (UUID). To get the report ID, copy the <code>report_identifier</code> returned when you <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/create-report.md">Create a report</a>. Otherwise, use the <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-report-history.md">List report history</a> endpoint.</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr>
<th>report</th>
<th>object</th>
<th>Object containing report details</th>
</tr>
</thead>
<tbody>
<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>.. 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_metadata</td>
<td>object</td>
<td>Object that defines the report type and data to include in the report.</td>
</tr>
<tr>
<td>.. .. columns</td>
<td>object</td>
<td>List of objects that define the columns to include in the report. The order of columns in this array matches the order of columns in the generated report.</td>
</tr>
<tr>
<td>.. .. .. identifier</td>
<td>string</td>
<td>Column identifier.<br><strong>Possible values:</strong> See <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-columns.md">List columns</a>. Column identifiers vary by report type.</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>.. .. filters</td>
<td>array of objects</td>
<td>List of objects that define the report's filters. To learn more about column filters, see <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/column-filters.md">Column filters</a>.</td>
</tr>
<tr>
<td>.. .. .. column_identifier</td>
<td>string</td>
<td>Column to filter by.<br><strong>Allowed values:</strong> Varies by report type. To get the list of columns you can use as filters for a given report type, use the <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-columns.md">List columns</a> endpoint.<br><strong>Note:</strong> In most cases, you can only add filters for columns included in the report. In other words, to add a filter, the <code>column_identifier</code> value for the filter must also be present in the <code>report_metadata.columns</code> array. However, some columns can only be used as filters. For these columns, you can add a filter, but you cannot include the column's identifier in the <code>report_metadata.columns</code> array. To see if a column can only be used as a filter, check the value of the <code>filter_only</code> parameter in the <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-columns.md">List columns</a> API response.</td>
</tr>
<tr>
<td>.. .. .. values</td>
<td>array of strings</td>
<td>List of values. For each row in the report, the value of the filtered column (<code>column_identifier</code>) is compared to the values in this list. A row is only included in the report if the filtered column contains a value that meets the filter criteria.<br>Not used if the <code>filter_type</code> for the column is static. For more information, see <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/column-filters/filters-reference-types-and-operators.md">Filters reference: Types and operators</a>.</td>
</tr>
<tr>
<td>.. .. .. filter_identifier</td>
<td>string</td>
<td>Operator that defines how to determine if the value in a column meets the filter criteria.<br><strong>Allowed values:</strong> Varies by column. To get the list of filter operators available for a given report type, use the <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/list-columns.md">List columns</a> endpoint. To learn more about filter operators, see <a href="https://dev.digicert.com/md/certcentral-apis/report-library-api/column-filters/filters-reference-types-and-operators.md">Filters reference: Types and operators</a>.</td>
</tr>
<tr>
<td>.. .. sources</td>
<td>object</td>
<td>Object with key/value pairs that determine the sources of data for the report. If the report type can use subaccounts and divisions as sources, and if the sources object is empty or not provided, these defaults are applied:<br><ul><li><code>&quot;division_filter_type&quot;: &quot;INCLUDE_ALL_DIVISIONS&quot;</code></li><li><code>&quot;sub_account_filter_type&quot;: &quot;EXCLUDE_ALL_SUB_ACCOUNTS&quot;</code></li></ul></td>
</tr>
<tr>
<td>.. .. .. division_filter_type</td>
<td>string</td>
<td>Defines divisions to include in the report.<br><strong>Possible values:</strong><br><ul><li><code>INCLUDE_ALL_DIVISIONS</code> (default) - Report includes data from all divisions in your account.</li><li><code>INCLUDE_TOP_DIVISION</code> - Report only includes data from the top-level division in your account.</li><li><code>CHOOSE_DIVISIONS</code> - Report includes data from divisions you add to the <code>divisions</code> array.</li><li><code>EXCLUDE_ALL_DIVISIONS</code> - Report only includes data from subaccounts. All parent account data is omitted. <strong>Note:</strong> Reports configured to omit parent account data must include subaccount data. In other words, when the value of <code>division_filter_type</code> is <code>EXCLUDE_ALL_DIVISIONS</code>, the value of <code>sub_account_filter_type</code> cannot be <code>EXCLUDE_ALL_SUB_ACCOUNTS</code>.</li></ul></td>
</tr>
<tr>
<td>.. .. .. divisions</td>
<td>array of integers</td>
<td>List of IDs for each division to include in the report.<br>Required if <code>division_filter_type</code> is <code>CHOOSE_DIVISIONS</code>.</td>
</tr>
<tr>
<td>.. .. .. sub_account_filter_type</td>
<td>string</td>
<td>Defines subaccounts to include in the report.<br><strong>Possible values:</strong><br><ul><li><code>INCLUDE_ALL_SUB_ACCOUNTS</code> - Report includes data from all subaccounts you manage.</li><li><code>EXCLUDE_ALL_SUB_ACCOUNTS</code> (default) - Report does not includes subaccount data.</li><li><code>CHOOSE_SUB_ACCOUNTS</code> - Report includes data from subaccounts you add to the <code>sub_accounts</code> array.</li></ul></td>
</tr>
<tr>
<td>.. .. .. sub_accounts</td>
<td>array of integers</td>
<td>List of IDs for each subaccount to include in the report.<br>Required if <code>sub_account_filter_type</code> is <code>CHOOSE_SUBACCOUNTS</code>.</td>
</tr>
<tr>
<td>.. schedule</td>
<td>object</td>
<td>Object with key/value pairs that define the report schedule.</td>
</tr>
<tr>
<td>.. .. frequency</td>
<td>string</td>
<td>Frequency of report creation.<br><strong>Possible values:</strong> <code>ON_DEMAND</code>, <code>WEEKLY</code>, and <code>MONTHLY</code></td>
</tr>
<tr>
<td>.. .. weekday_to_run</td>
<td>string</td>
<td>Day of the week the scheduler initiates a report run.<br><strong>Possible values:</strong> <code>SUNDAY</code> to <code>SATURDAY</code></td>
</tr>
<tr>
<td>.. .. weekday_frequency</td>
<td>string</td>
<td>Week of the month to initiate a report run.<br><strong>Possible values:</strong> <code>FIRST</code>, <code>SECOND</code>, <code>THIRD</code>, <code>FOURTH</code>, <code>LAST</code></td>
</tr>
<tr>
<td>.. .. repeat_every</td>
<td>string</td>
<td>Number of weeks or months between each report run.</td>
</tr>
<tr>
<td>.. .. repeat_on</td>
<td>string</td>
<td>For monthly reports, whether to initiate report runs on a specific day or date.<br><strong>Possible values:</strong><br><ul><li><code>DAY_OF_THE_MONTH</code> - Initiate report runs on a specific day (for example, on the first Monday of the month.</li><li><code>DATE_OF_THE_MONTH</code> - Initiate report runs on a specific date (for example, on the 10th day of the month) .</li></ul></td>
</tr>
<tr>
<td>.. .. repeat_on_date</td>
<td>object</td>
<td>Object with key/value pairs defining a monthly date when the report run initiates.</td>
</tr>
<tr>
<td>.. .. .. date</td>
<td>integer</td>
<td>Day of the month on which a new report run is initiated.<br><strong>Range:</strong> 1-31</td>
</tr>
<tr>
<td>.. .. .. last_day_of_the_month</td>
<td>boolean</td>
<td>If true, a new report run is initiated on the last day of the month. Otherwise, false.</td>
</tr>
<tr>
<td>.. .. run_until</td>
<td>string</td>
<td>Date to stop generating reports. If undefined, the scheduler will continue to initiate report runs until you disable the report.<br><strong>Format:</strong> <code>YYYY-MM-DD</code></td>
</tr>
<tr>
<td>.. next_run_date</td>
<td>string</td>
<td>Starting date and time (UTC) of the next report run.<br><strong>Format:</strong> <code>YYYY-MM-DD hh:mm:ss</code></td>
</tr>
<tr>
<td>.. format</td>
<td>array of strings</td>
<td>File format in which you can download the results of a report run.</td>
</tr>
<tr>
<td>.. status</td>
<td>string</td>
<td>Report status.</td>
</tr>
<tr>
<td>.. notification_emails</td>
<td>array of objects</td>
<td>List of objects with information about users to notify when a report is generated and ready for download.</td>
</tr>
<tr>
<td>.. .. user_id</td>
<td>integer</td>
<td>User ID.</td>
</tr>
<tr>
<td>.. .. first_name</td>
<td>string</td>
<td>User first name.</td>
</tr>
<tr>
<td>.. .. last_name</td>
<td>string</td>
<td>User last name.</td>
</tr>
<tr>
<td>.. .. email</td>
<td>string</td>
<td>User email address.</td>
</tr>
</tbody>
</table>