Skip to main content

List columns

GET https://api.digicert.com/reports/v1/report/types/{{report_type}}/supported-columns

Use this endpoint to list details about the columns and filters you can add to a report of a given report_type.

Example requests and responses

Path parameters

Name

Req/Opt

Description

report_type

required

Report type.

Possible values:orders, domains, balance-history, audit-logs, organizations, fqdn, users

URL query parameters

Name

Req/Opt

Type

Description

language_id

optional

integer

ID of the language to use for the strings returned in these fields:

  • display_category_name

  • display_sub_category_name

  • display_name

Allowed values: See Glossary – Locale codes.

Default: English (1)

Response parameters

Name

Type

Description

display_categories

array of objects

List of objects containing details about the column categories available for the report_type in the request URL.

.. display_category_name

string

Column category display name. To get this value in a language other than English, use the language_id query parameter.

.. display_sub_categories

array of objects

List of objects containing details about each column subcategory.

.. .. display_sub_category_name

string

Column subcategory display name. To get this value in a language other than English, use the language_id query parameter.

.. .. display_columns

array

List of objects with details about each column.

.. .. .. identifier

string

Column identifier.

.. .. .. display_name

string

Column display name. To get this value in a language other than English, use the language_id query parameter.

.. .. .. field_type

string

Data type of the value that the column contains in the report.

Possible values:STRING, INTEGER, DATE

.. .. .. enabled

boolean

If true, the column is enabled, and you can include data from the column in a report.

If false, you cannot include the column in a report. You can still add a filter for the column (see filter_only).

.. .. .. supported_operators

array of objects

List of objects with details about the operators you can use to add filters for this column while building a custom report.

.. .. .. .. operator_identifier

string

Operator ID.

Possible values: See Filters reference: Types and operators

.. .. .. .. display_name

string

Operator display name.

.. .. .. subaccount_column

boolean

If true, the column only contains data for subaccounts. Otherwise, false.

.. .. .. is_required

boolean

If true, the column is required in all reports of the given report_type. Otherwise, false.

.. .. .. recommended_default

boolean

If true, we recommend you always include the column when building reports of the specified report_type. Otherwise, false.

.. .. .. filter_only

boolean

If true, you can add a filter for the column, but you cannot include data from the column in a report.

If false, you can include the column in a report. Also, if the column has filter operators, you can use an operator_identifier from the list of supported_operators to add a filter for the column.

.. .. .. filter_type

string

Filter type for the column. The filter type describes the values the column can be filtered against.

Possible values: See Filters reference: Types and operators

.. .. .. possible_values

array of strings

List of possible values to use as filter criteria when adding a filter for the column.

  • If a column object includes a list of possible values: The filter criteria for the column is restricted to these values. If you try to build a report using other values as the filter criteria for this column, the API returns an error.

  • If a column object does not include a list of possible values: There are no restrictions on the filter criteria for the column. You can build a report using any values you choose as the filter criteria for this column.

In this section: