Skip to main content

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

Path parameters

Name

Req/Opt

Description

report_identifier

required

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 to include in the report.

.. .. columns

object

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.

.. .. .. 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 objects

List of objects that define the report's filters. To learn more about column filters, see Column filters.

.. .. .. column_identifier

string

.. .. .. values

array of strings

.. .. .. filter_identifier

string

.. .. 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

.. .. .. divisions

array of integers

.. .. .. sub_account_filter_type

string

.. .. .. sub_accounts

array of integers

.. 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

.. .. 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 on which a new report run is initiated.

Range: 1-31

.. .. .. last_day_of_the_month

boolean

If true, a new report run is initiated 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

array of strings

File format 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 users to notify 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.