Request an async encrypted conversation/session export
POST
/
v1
/
conversations
/
exports
Request an async encrypted conversation/session export
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/conversations/exports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"export_format": "csv",
"channel": "<string>",
"status": "<string>",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"q": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_session_id": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/conversations/exports"
payload = {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"export_format": "csv",
"channel": "<string>",
"status": "<string>",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"q": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_session_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
export_format: 'csv',
channel: '<string>',
status: '<string>',
end_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assigned_agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
q: '<string>',
from_number: '<string>',
to_number: '<string>',
email: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
external_session_id: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/conversations/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.featherhq.com/v1/conversations/exports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'export_format' => 'csv',
'channel' => '<string>',
'status' => '<string>',
'end_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assigned_agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'q' => '<string>',
'from_number' => '<string>',
'to_number' => '<string>',
'email' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'external_session_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.featherhq.com/v1/conversations/exports"
payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.featherhq.com/v1/conversations/exports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/conversations/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"export_format": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"total_rows": 123,
"error_code": "<string>",
"filters": {},
"files": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
POST body for an async encrypted conversation/session export.
Every optional field below is a narrowing filter with the SAME meaning and
the SAME implementation as the matching GET /v1/conversations query
param — both go through src/conversation/session_filters.py, so an
export cannot select a different set of sessions than the list the operator
was looking at. The export is channel-agnostic by default; channel just
narrows it. [start, end) is always required and is not a "filter" in
this sense — it bounds the job's size.
Available options:
csv, ndjson Available options:
low, normal, high, urgent Available options:
has_evals, no_evals, all_passed, any_failed Response
Successful Response
Status view of an export job (with per-file download tokens when ready).
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Request an async encrypted conversation/session export
curl --request POST \
--url https://api-sandbox.featherhq.com/v1/conversations/exports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"export_format": "csv",
"channel": "<string>",
"status": "<string>",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"q": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_session_id": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/conversations/exports"
payload = {
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"export_format": "csv",
"channel": "<string>",
"status": "<string>",
"end_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"q": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"email": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_session_id": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start: '2023-11-07T05:31:56Z',
end: '2023-11-07T05:31:56Z',
export_format: 'csv',
channel: '<string>',
status: '<string>',
end_user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assigned_agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
q: '<string>',
from_number: '<string>',
to_number: '<string>',
email: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
external_session_id: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/conversations/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.featherhq.com/v1/conversations/exports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start' => '2023-11-07T05:31:56Z',
'end' => '2023-11-07T05:31:56Z',
'export_format' => 'csv',
'channel' => '<string>',
'status' => '<string>',
'end_user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assigned_agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'q' => '<string>',
'from_number' => '<string>',
'to_number' => '<string>',
'email' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'external_session_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.featherhq.com/v1/conversations/exports"
payload := strings.NewReader("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.featherhq.com/v1/conversations/exports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/conversations/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start\": \"2023-11-07T05:31:56Z\",\n \"end\": \"2023-11-07T05:31:56Z\",\n \"export_format\": \"csv\",\n \"channel\": \"<string>\",\n \"status\": \"<string>\",\n \"end_user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assigned_agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"q\": \"<string>\",\n \"from_number\": \"<string>\",\n \"to_number\": \"<string>\",\n \"email\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_session_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"export_format": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z",
"window_end": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"finalized_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"total_rows": 123,
"error_code": "<string>",
"filters": {},
"files": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}