Jump to

• Request
• Response

Start Export Task

post

/api/v1/bots/insightDataExport

Creates and starts an asynchronous job to export the instance's insights data into a ZIP of CSV files. You can filter the data to export by name, a date range, or both. The response includes a resourceId value, which you can use for the exportId when you call GET /bots/insightDataExport/{exportId}/data to download the exported data.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

A description of the data to export.

Root Schema : schema

Type: object

Show Source

• beginDate(required): string (date)
  Pattern: YYYY-MM-DD

  Range start date.
• createdByName(required): string
  A name that identifies who created the export task.
• endDate(required): string (date)
  Pattern: YYYY-MM-DD

  Range end date.
• name: string
  Name for the export task. The name must begin with a letter and it can contain only letters, numbers, and underscores.

  Example: FebInstanceExport
• type(required): string
  Allowed Values: [ "EXPORT", "EXPORT_AND_PURGE" ]

  Use EXPORT to export and retain the data and use EXPORT_AND_PURGE to export the data and then delete it.

{
    "required":[
        "beginDate",
        "createdByName",
        "endDate",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Use <code>EXPORT</code> to export and retain the data and use <code>EXPORT_AND_PURGE</code> to export the data and then delete it.",
            "enum":[
                "EXPORT",
                "EXPORT_AND_PURGE"
            ]
        },
        "name":{
            "type":"string",
            "description":"Name for the export task.  The name must begin with a letter and it can contain only letters, numbers, and underscores.",
            "example":"FebInstanceExport"
        },
        "beginDate":{
            "pattern":"YYYY-MM-DD",
            "type":"string",
            "description":"Range start date.",
            "format":"date"
        },
        "endDate":{
            "pattern":"YYYY-MM-DD",
            "type":"string",
            "description":"Range end date.",
            "format":"date"
        },
        "createdByName":{
            "type":"string",
            "description":"A name that identifies who created the export task."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : InsightsExportTaskResponse

Type: object

Show Source

• jobName: string
  The name of the export job as specified in the create request.
• resourceId: string
  The export task's ID.

{
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string",
            "description":"The name of the export job as specified in the create request."
        },
        "resourceId":{
            "type":"string",
            "description":"The export task's ID."
        }
    }
}

Back to Top