List report types

3 minute read

GET https://api.digicert.com/reports/v1/report/types

Use this endpoint to get information about each type of report you can generate.

Example requests and responses

cURL

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

200 OK

{
  "report_types": [
    {
      "report_type": "orders",
      "display_name": "Orders",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": true,
      "sub_account_enabled": true,
      "division_enabled": true,
      "report_description": "Includes data from all orders you have access to and purchase history.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "balance-history",
      "display_name": "Balance history",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": true,
      "report_description": "Review your account balance and keep track of its history here.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "fqdn",
      "display_name": "FQDN",
      "supported_formats": [
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": false,
      "report_description": "Monitor your total FQDN and wildcard usage for active orders.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "domains",
      "display_name": "Domains",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": false,
      "report_description": "Generate valid domain reports with OV, EV, and DCV method validation details.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "audit-logs",
      "display_name": "Audit log",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": true,
      "report_description": "Run and download audit reports to make tracking audits easier.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "organizations",
      "display_name": "Organizations",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": false,
      "report_description": "Track your organizations to stay informed about their validation status and revalidate organizations about to expire.",
      "status": true,
      "is_customisable": true
    },
    {
      "report_type": "users",
      "display_name": "Users",
      "supported_formats": [
        "CSV",
        "JSON",
        "EXCEL"
      ],
      "custom_fields_enabled": false,
      "sub_account_enabled": true,
      "division_enabled": true,
      "report_description": "View users with access to this account. Can include access role and last login date.",
      "status": true,
      "is_customisable": true
    }
  ]
}

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: Allowed values: See Glossary - Locale codes Default: English (`1`)

Response parameters

Name	Type	Description
report_types	object	List of objects. Each object contains information about a type of report you can create with the Report Library API.
.. report_type	string	Report type identifier. Possible values: `orders`, `domains`, `balance-history`, `audit-logs`, `organizations`, `fqdn`, `users`
.. display_name	string	Display name for the report type. To get this value in a language other than English, use the `language_id` query parameter.
.. supported_formats	array	List of file type formats the report type supports. Possible values:`CSV`, `JSON`, `EXCEL`
.. custom_fields_enabled	boolean	If true, report type can include data from custom order fields. Otherwise, false. Note: Data from custom fields can only be included in `orders` reports.
.. sub_account_enabled	boolean	If true, report type can include data from a customized selection of subaccounts you manage. Otherwise, false.
.. division_enabled	boolean	If true, report type can include data from a customized selection of divisions in your account. Otherwise, false. Note: Only `orders`, `balance-history`, `audit-logs`, and `users` reports allow customizing division sources.
.. report_description	string	Report type description. To get this value in a language other than English, use the `language_id` query parameter.
.. is_customizable	boolean	If true, you can customize the columns included in this type of report. Otherwise, false.