Downloads
Export
Export the full raw scan information and push it to your servers.
POST
Request
Path Parameters
string
required
A new Id for the export process.
>= 3 characters <= 36 charactersstring
required
The scan ID of the specific scan to export. Learn more about the criteria for creating a Scan ID.
>= 3 characters <= 36 charactersHeaders
Request Body
The request body is a JSON object containing the export configuration.string
required
This webhook event is triggered once the export is completed.
array[array]
Adds headers to the webhook.Example:
[ [ "header-key", "header-value" ], ... ]integer
default:"3"
How many retries to send before giving up. Using high value (12) may lead to a longer time until the completionWebhook being executed. A low value (1) may lead to errors while your service is temporary having problems.
>= 1 <= 12string
Add a custom developer payload that will then be provided on the Export-Completed webhook.
array[object]
An array of results to be exported. Learn more about Result Webhook.
<= 1000 itemsobject
Download the PDF report. Allowed only when
properties.pdf.create was set to true on the scan submission.object
Export the AI Content detection report. Allowed only when
properties.aiGeneratedText.detect was set to true on the scan submission. Learn more about AI Content Detection Webhook.object
Export the Grammar Checker report. Allowed only when
properties.writingFeedback.enable was set to true on the scan submission. Learn more about Grammar Checker Webhook.object
Export the Overview report. Allowed only when
properties.overview.enable was set to true on the scan submission. Learn more about Overview Webhook.object
Download the crawled version of the submitted text. Learn more about Crawled-Version Webhook.
Responses
- 204
- 400
- 401
- 404
- 409
204 No Content - The command was executed. The export started.
Next Steps
Webhooks Overview
Learn about the different types of webhooks and how to handle them, including export completion webhooks.
Export Completed Webhook
Understand the details provided in the export completed webhook.
How to Display Scan Reports
Learn how to present exported scan data to your users.

