Report details

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

Name Req/Opt Description
report_identifier required Report ID (UUID). To get the report ID, copy the report_identifier returned when you Create a report. Otherwise, use the List report history endpoint.

Response parameters

Name Type Description
report object Object containing report details.
.. report_display_name string Report display name.
.. report_identifier string Report ID (UUID).
.. created_by_user_id string ID of the user that created the report.
.. created_date string Report creation date and timestamp in UTC.
Format: YYYY-MM-DD hh:mm:ss
.. created_by_user_name string Username of the user that created the report.
.. report_metadata object Object that defines the report type and data included in the report.
.. .. columns array of objects List of objects that define the columns included in the report.
.. .. .. identifier string Column identifier.
Possible values: See List columns. Column identifiers vary by report type.
.. .. report_type string Report type.
Possible values: See List report types.
.. .. filters array of strings List of objects that define the report's filters.
To learn more about column filters, see Column filters
.. .. .. column_identifier string Column to filter by.
Possible values: Varies by report type. To get the list of columns you can use as filters for a given report type, use the List columns endpoint.
.. .. .. values array of strings List of values. For each row in the report, the value of the filtered column (column_identifier) 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.

Not used if the filter_type for the column is static. For more information, see Filters reference and examples - Filter types.
.. .. .. filter_identifier string Operator that defines how to determine if the value in a column meets the filter criteria.
Allowed values: Varies by column. To get the list of filter operators available for a given report type, use the List columns endpoint. To learn more about filter operators, see Filters reference and examples - Filter operators.
.. .. sources object 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:
  • "division_filter_type": "INCLUDE_ALL_DIVISIONS"
  • "sub_account_filter_type": "EXCLUDE_ALL_SUB_ACCOUNTS"
.. .. .. division_filter_type string Defines divisions to include in the report.
Possible values:
  • INCLUDE_ALL_DIVISIONS (default) - Report includes data from all divisions in your account.
  • INCLUDE_TOP_DIVISION - Report only includes data from the top-level division in your account.
  • CHOOSE_DIVISIONS - Report includes data from divisions you add to the divisions array.
.. .. .. divisions array of integers List of IDs for each division to include in the report.
Required if division_filter_type is CHOOSE_DIVISIONS.
.. .. .. sub_account_filter_type string Defines subaccounts to include in the report.
Possible values:
  • INCLUDE_ALL_SUB_ACCOUNTS - Report includes data from all subaccounts you manage.
  • EXCLUDE_ALL_SUB_ACCOUNTS (default) - Report does not includes subaccount data.
  • CHOOSE_SUB_ACCOUNTS - Report includes data from subaccounts you add to the sub_accounts array.
.. .. .. sub_accounts array of integers List of IDs for each subaccount to include in the report.
Required if sub_account_filter_type is CHOOSE_SUBACCOUNTS.
.. schedule object Object with key/value pairs that define the report schedule.
.. .. frequency string Frequency of report creation.
Possible values: ON_DEMAND, WEEKLY, and MONTHLY (case-sensitive).
.. .. weekday_to_run string Day of the week the scheduler initiates a report run.
Possible values: SUNDAY to SATURDAY
.. .. weekday_frequency string Week of the month to initiate a report run.
Possible values: FIRST, SECOND, THIRD, FOURTH, LAST
.. .. repeat_every string Number of weeks or months between each report run.
.. .. repeat_on string For monthly reports, whether to initiate report runs on a specific day or date.
Possible values:
  • DAY_OF_THE_MONTH - Initiate report runs on a specific day (for example, on the first Monday of the month).
  • DATE_OF_THE_MONTH - Initiate report runs on a specific date (for example, on the 10th day of the month) .
.. .. repeat_on_date object Object with key/value pairs defining a monthly date when the report run initiates.
.. .. .. date integer Day of the month the scheduler initiates a new report run.
Range: 1-31
.. .. .. last_day_of_the_month boolean If true, scheduler initiates a new report run on the last day of the month. Otherwise, false.
.. .. run_until string Date to stop generating reports. If undefined, the scheduler will continue to initiate report runs until you disable the report.
Format: YYYY-MM-DD.
.. next_run_date string Starting date and time (UTC) of the next report run.
Format: YYYY-MM-DD hh:mm:ss
.. format string List of filetype formats in which you can download the results of a report run.
.. status string Report status.
.. notification_emails array of objects List of objects with information about the users notified when a report is generated and ready for download.
.. .. user_id integer User ID.
.. .. first_name string User first name.
.. .. last_name string User last name.
.. .. email string User email address.