Jump to

• Request
• Response

Start Export Task

post

/api/v1/bots/insights/dataExports

Creates and starts an asynchronous task to export a digital assistant's or skill's insights data into a ZIP file that's stored in the instance. You can filter which data to export by a digital assistant's ID, a skill's bot name and optional version, or by a bot ID. You also can filter by a date range. You also can use this operation to purge all insights data for a date range. The response includes a jobId, which you can use for the task's ID in other insights export operations.

Request

Query Parameters

• botId(required): string
  The unique ID that identifies a version of a skill or digital assistant to export.
• botName(required): string
  The bot name of the skill to export. Note that you can provide a botName or a botId but not both. You can optionally use the botVersion query parameter along with this parameter.
• botVersion(required): string
  The bot version of the skill to export. Use this parameter when you specify a botName and you want to retrieve a specific version.
• maxFileLength(required): string
  The maximum number of lines to add to an exported file before starting a new file.

  Default Value: 100000000
• odaId(required): string
  The unique ID that identifies a version of a digital assistant to export. The exported file contains data for the digital assistant and its skills. Note that you can filter by digital assistant or by skill but not both.
• piiAnonymizeExport(required): boolean
  A boolean flag that specifies whether to modify the personally identifiable information (PII) in the exported data. Set to true to modify all the PII text in the exported data and false to export original data. Defaults to false.

  Default Value: false
• since(required): string
  The start date for the data to export, inclusive. Format: yyyy-mm-dd. Defaults to 1 year before the until date.
• until(required): string
  The end date for the data to export, inclusive. Format: yyyy-mm-dd. Defaults to today.

Supported Media Types

• application/json

Request Body - application/json ()

Describes an insights export task.

Root Schema : schema

Type: object

Describes an insights export task.

Show Source

• insightsDataExport: boolean
  Default Value: false

  A boolean flag that indicates how much data to include in the export. Set to true to include just the essential data, and false to include all data.

  You can see a description of the output when the property is set to true at Export Log Fields in Using Oracle Digital Assistant.

  When false the dialog_context is base64 encoded.

• name: string
  A user-specified name for the task. If not specified, then a name is generated.
• taskType(required): string
  Allowed Values: [ "EXPORT", "EXPORT_PURGE" ]

  The type of task to start.

  • EXPORT: Use this to start an export .
  • EXPORT_PURGE: Use this to start an export that will also purge data. You can't use this type with the botName, botId, or odaId query parameter.

{
    "required":[
        "taskType"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"A user-specified name for the task. If not specified, then a name is generated."
        },
        "taskType":{
            "type":"string",
            "description":"The type of task to start.<ul><li><code>EXPORT</code>: Use this to start an export .</li><li><code>EXPORT_PURGE</code>: Use this to start an export that will also purge data. You can't use this type with the botName, botId, or odaId query parameter.</li></ul>",
            "enum":[
                "EXPORT",
                "EXPORT_PURGE"
            ]
        },
        "insightsDataExport":{
            "type":"boolean",
            "description":"<p>A boolean flag that indicates how much data to include in the export. Set to <code>true</code> to include just the essential data, and <code>false</code> to include all data.<p>\n<p>You can see a description of the output when the property is set to <code>true</code> at <a href=\"http://www.oracle.com/pls/topic/lookup?ctx=en/cloud/paas/digital-assistant&id=DACUA-GUID-DA624B83-6341-4B57-9145-8D9635D3376A\" target=\"_blank\">Export Log Fields</a> in <i>Using Oracle Digital Assistant</i>.</p>\n<p>When <code>false</code> the <code>dialog_context</code> is base64 encoded.</p>",
            "default":false
        }
    },
    "description":"Describes an insights export task."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : JobIdentifier

Type: object

Show Source

• jobId: string
  The unique ID of the task.

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"The unique ID of the task."
        }
    }
}

400 Response

Failed. Details are provided in the response body.

Back to Top