Jump to

• Request
• Response

Get Export Task

get

/api/v1/bots/{botId}/insightExports/{exportId}

Returns information about the skill-level export task.

Request

Path Parameters

• botId(required): string
  The ID of the skill bot.
• exportId(required): string
  The export task's ID. This is the same as the task's resourceId.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : InsightsExportOutput

Type: object

Show Source

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

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

  Range end date.
• filters: object filters
  Include only the data for the specified intent, channel, or locale or any combination of the three filters.
• name: string
  A unique name, which is derived from the user-specified task name

{
    "required":[
        "beginDate",
        "endDate"
    ],
    "type":"object",
    "properties":{
        "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"
        },
        "filters":{
            "type":"object",
            "description":"Include only the data for the specified intent, channel, or locale or any combination of the three filters.",
            "example":{
                "filter":{
                    "meta":"",
                    "enclose1":{
                        "meta":"",
                        "enclose2":{
                            "meta":"",
                            "profileString":{
                                "column":"INTENT",
                                "test":{
                                    "op":"matches one of",
                                    "arg":"Balances;Accounts"
                                }
                            }
                        }
                    },
                    "bool3":{
                        "content":"and"
                    },
                    "enclose4":{
                        "meta":"",
                        "enclose5":{
                            "meta":"",
                            "profileString":{
                                "column":"CHANNEL",
                                "test":{
                                    "op":"matches one of",
                                    "arg":"test; facebook"
                                }
                            }
                        }
                    },
                    "bool6":{
                        "content":"and"
                    },
                    "enclose7":{
                        "meta":"",
                        "enclose8":{
                            "meta":"",
                            "profileString":{
                                "column":"BR_LANG",
                                "test":{
                                    "op":"matches one of",
                                    "arg":"en-US; en-UK"
                                }
                            }
                        }
                    }
                }
            }
        },
        "createdByName":{
            "type":"string",
            "description":"A name that identifies who created the export task."
        },
        "name":{
            "type":"string",
            "description":"A unique name, which is derived from the user-specified task name"
        }
    }
}

Nested Schema : filters

Type: object

Include only the data for the specified intent, channel, or locale or any combination of the three filters.

Example:

{
    "filter":{
        "meta":"",
        "enclose1":{
            "meta":"",
            "enclose2":{
                "meta":"",
                "profileString":{
                    "column":"INTENT",
                    "test":{
                        "op":"matches one of",
                        "arg":"Balances;Accounts"
                    }
                }
            }
        },
        "bool3":{
            "content":"and"
        },
        "enclose4":{
            "meta":"",
            "enclose5":{
                "meta":"",
                "profileString":{
                    "column":"CHANNEL",
                    "test":{
                        "op":"matches one of",
                        "arg":"test; facebook"
                    }
                }
            }
        },
        "bool6":{
            "content":"and"
        },
        "enclose7":{
            "meta":"",
            "enclose8":{
                "meta":"",
                "profileString":{
                    "column":"BR_LANG",
                    "test":{
                        "op":"matches one of",
                        "arg":"en-US; en-UK"
                    }
                }
            }
        }
    }
}

404 Response

The skill or export task doesn't exist or insights aren't enabled for the skill.

Back to Top