Jump to

• Request
• Response

Get Export Task

get

/api/v1/bots/insightDataExport/{exportId}

Returns a description of the given instance-level export task.

Request

Path Parameters

• exportId(required): string
  The export task's ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : InsightsDataExportResponse

Type: object

The items being returned.

Show Source

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

  Range start date.
• createdByName(required): string
  Read Only: true

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

  Range end date.
• jobName: string
  The name of the export job as specified in the create request.
• jobTimestamp: string (date)
  Timestamp of when the job started.
• resourceId: string
  The export task's id.
• status: string
  Allowed Values: [ "PURGE_SUCCEEDED", "PURGE_FAILED", "EXPORT_SUCCEEDED", "EXPORT_FAILED", "NO_DATA", "SUBMITTED", "IN_PROGRESS" ]

  The current status of the export.

  • SUBMITTED: The export was submitted.
  • IN_PROGRESS: The export is in progress.
  • PURGE_SUCCEEDED: The purge completed successfully.
  • PURGE_FAILED: The purge failed. The error property provides more information.
  • EXPORT_SUCCEEDED: The export completed successfully.
  • EXPORT_FAILED: The export failed. The error property provides more information.
  • NO_DATA: There wasn't any data to export or purge. Try a different date range or filter.

{
    "required":[
        "createdByName"
    ],
    "type":"object",
    "properties":{
        "createdByName":{
            "type":"string",
            "description":"A name that identifies who created the export task.",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"The current status of the export.<ul><li><code>SUBMITTED</code>: The export was submitted.</li><li><code>IN_PROGRESS</code>: The export is in progress.</li><li><code>PURGE_SUCCEEDED</code>: The purge completed successfully.</li><li><code>PURGE_FAILED</code>: The purge failed. The <code>error</code> property provides more information.</li><li><code>EXPORT_SUCCEEDED</code>: The export completed successfully.</li><li><code>EXPORT_FAILED</code>: The export failed. The <code>error</code> property provides more information.</li><li><code>NO_DATA</code>: There wasn't any data to export or purge. Try a different date range or filter.</li></ul>",
            "enum":[
                "PURGE_SUCCEEDED",
                "PURGE_FAILED",
                "EXPORT_SUCCEEDED",
                "EXPORT_FAILED",
                "NO_DATA",
                "SUBMITTED",
                "IN_PROGRESS"
            ]
        },
        "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."
        },
        "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"
        },
        "jobTimestamp":{
            "type":"string",
            "description":"Timestamp of when the job started.",
            "format":"date"
        }
    },
    "description":"The items being returned."
}

404 Response

The export task doesn't exist.

Back to Top