List Export Tasks
get
/api/v1/bots/insightDataExport
Returns a list of insights-export tasks for this service instance.
Request
Query Parameters
-
limit: integer(int64)
The number of items to return.Default Value:
100
-
offset: integer(int64)
The number of items to skip before starting to collect the result set, where
0
is the first item.Default Value:0
-
totalResults: boolean
Whether to return the total number of items that match the request (excluding the paging parameters).Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success.
Root Schema : InsightsDataExportPagingData
Type:
object
List of an instance's insights-export tasks.
Show Source
-
count: integer
(int32)
The number of items returned.
-
hasMore: boolean
Indicates if there are more items to be returned.
-
items: array
items
The items being returned.
-
limit: integer
(int32)
The maximum number of items to return.
-
links: array
links
-
offset: integer
(int32)
The actual index from which the items are returned.
-
totalResults: integer
(int32)
The total number of items.
Nested Schema : items
Type:
array
The items being returned.
Show Source
-
Array of:
object InsightsDataExportResponse
The items being returned.
Nested 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. Theerror
property provides more information.EXPORT_SUCCEEDED
: The export completed successfully.EXPORT_FAILED
: The export failed. Theerror
property provides more information.NO_DATA
: There wasn't any data to export or purge. Try a different date range or filter.
Nested Schema : selfLinks
Type:
Show Source
object
-
absolutePath: string
(uri)
-
absolutePathBuilder: object
absolutePathBuilder
-
baseUri: string
(uri)
-
baseUriBuilder: object
baseUriBuilder
-
matchedResources: array
matchedResources
-
matchedURIs: array
matchedURIs
-
path: string
-
pathParameters: object
pathParameters
Additional Properties Allowed: additionalProperties
-
pathSegments: array
pathSegments
-
queryParameters: object
queryParameters
Additional Properties Allowed: additionalProperties
-
requestUri: string
(uri)
-
requestUriBuilder: object
requestUriBuilder
Nested Schema : Link
Type:
Show Source
object
-
href: string
URL to the resource
-
rel: string
The relationship with the resource
Nested Schema : absolutePathBuilder
Type:
object
Nested Schema : baseUriBuilder
Type:
object
Nested Schema : requestUriBuilder
Type:
object
Nested Schema : items
Type:
object
Nested Schema : items
Type:
Show Source
object
-
matrixParameters: object
matrixParameters
Additional Properties Allowed: additionalProperties
-
path: string