Download report

3 minute read

GET

https://api.digicert.com/reports/v1/report/{{report_identifier}}/{{report_run_identifier}}download?report_format={{format}}

Use this endpoint to download the results of a report run.

To download the report as a single file, pass the file format (CSV, JSON, or EXCEL) as the value of the report_format query string.
To download a compressed .zip file with the report data, pass a value of ZIP for the report_format query string.

You can only download reports in the format chosen when you created the report. To get the report format, use the Report details endpoint (see format).

Important

JSON, CSV, and Excel files larger than 2 MB always download in a compressed .zip file, regardless of the value of the report_format query string.

Reports with multiple files

Reports with many rows are split into multiple files. For these reports, you must download each file one at a time. Reports with multiple files always download in a compressed .zip file.

To specify which file in the sequence to download, include the split_report_sequence query string in the request URL. Set its value to the sequence number of the file to download. The sequence number starts at 0 for the first file, and can increase up to n, where n is the number for the last file in the sequence. To see how many files a report run is split into, see the split_report_count parameter in the List report history response.

For example, use this query string to download the third file (sequence number = 2) in the sequence:

https://api.digicert.com/reports/v1/report/{{report_identifier}}/{{report_run_identifier}}/download?report_format={{report_format}}&split_report_sequence=2

The threshold for splitting reports into multiple files varies by report type. Also, for order reports, the maximum number of rows per file is lower if the report includes PEM-encoded certificate data for each order.

Report type	Maximum number of rows per file
Orders (with `certificate_pem_format` column)	10,000
Orders (without `certificate_pem_format` column)	200,000
Domains	50,000
Balance history	1,000,000
Audit logs	1,000,000
Organizations	1,000,000
Users	1,000,000
FQDN*	–

Note

*FQDN reports are never split into multiple files. For more information, see Report Library API - Report formats.

Naming conventions for report downloads

Downloaded report files are saved as:

{{display name}}-{{download date as YYYY-MM-DD}}.{{file_extension}}

The file extension is based on the report_format. For example: Single_file_report-2021-01-27.csv

If the report is split into multiple files, each file in the sequence is downloaded as compressed .zip. The filename is appended with an _n, where n is replaced with the sequence number of the downloaded file. For example: Multi_file_report-2021-01-27_5.zip

Example requests and responses

cURL

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

200 OK

// Report download

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.
report_run_identifier	required	ID of the specific report run to download (UUID). To get the report run ID, use the List report history endpoint.

URL query parameters

Name	Req/Opt	Type	Description
report_format	required	string	Format of the downloaded report. Must be the format you chose when you created the report. Allowed values:`JSON`, `CSV`, `EXCEL`, or ZIP
split_report_sequence	optional	integer	Sequence number of the file to download. The sequence number starts at 0 for the first file, and can increase up to n, where n is the number for the last file in the sequence. To see how many files a report run is split into, see the `split_report_count` parameter in the List report history response.