POST/api/public/exports/

Export data

You can export data from specific section (People/Deals/etc.) or campaign logs (Email deliveries/clicks or SMS deliveries) based on segment (for sections) as well as based on date of campaign sending or user's click/opening/unsubscription.

Attributes	Type	Required	Description
segment	integer	yes / no	A unique identifier for the segment of People/Deals/etc. (required and possible to use for the sections, deals' stage changes and people timelines)
date_from	date (Y-m-d)	no	A date from which the data will be returned (format: Y-m-d, e.g., 2024-01-15). (possible to use only for logs and people timelines)
date_to	date (Y-m-d)	no	A date to which the data will be returned (format: Y-m-d, e.g.,2024-01-31). (possible to use only for logs)
filter_by	array	no	Array of email action types to filter by, based on the date_from and date_to. Must always be an array format (even for single values): sent_at (default) opened_at clicked_at unsubscribed_at Examples: Single filter: ["sent_at"] Multiple filters: ["sent_at", "opened_at", "clicked_at"]
event_id	integer	yes / no	ID of the specific event. (required and possible to use only for the event occurrences export)
deal_id	integer	no	ID of the specific deal. (possible to use only for the deals stage changes export)
type	string	yes	Type of the exported data. Those can be: Section people products deals companies activities Logs email_delivery_logs sms_delivery_logs email_clicks events deals_stage_changes people_timelines

Request

CURL

curl -X POST
    "https://<your_app_subdomain>.user.com/api/public/exports/"
    -H 'authorization: Token <your_64_char_api_key>'
    -H 'content-type: application/json'
    -H "Accept: */*; version=2"
    -d '{
    "type": "people",
    "segment": 1
}'

JavaScript

var data = JSON.stringify({
    "type": "people",
    "segment": 1
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.#### ResponseText);
  }
});

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/exports/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("accept", "*/*; version=2");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/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 => "{\n\t\"type\": \"people\",\n\t\"segment\": 12\n}",
  CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
    "authorization: Token <your_64_char_api_key>",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://<your_app_subdomain>.user.com/api/public/exports/"

payload = "{\n\t\"type\": \"people\",\n\t\"segment\": 12\n}"
headers = {
    'authorization': "Token <your_64_char_api_key>",
    'Accept': "*/*; version=2",
    'content-type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Response

{
  "filename": "d1d69214-d07f-418f-bd85-27c49fd3398f.csv"
}

Email logs export example

CURL

curl -X POST
    "https://<your_app_subdomain>.user.com/api/public/exports/"
    -H 'authorization: Token <your_64_char_api_key>'
    -H 'content-type: application/json'
    -H "Accept: */*; version=2"
    -d '{
    "type": "email_delivery_logs",
    "date_from": "2024-01-01",
    "date_to": "2024-01-31",
    "filter_by": ["sent_at", "opened_at"]
}'

JavaScript

var data = JSON.stringify({
  type: "email_delivery_logs",
  date_from: "2024-01-01",
  date_to: "2024-01-31",
  filter_by: ["sent_at", "opened_at"],
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/exports/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("accept", "*/*; version=2");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/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 => "{\n\t\"type\": \"email_delivery_logs\",\n\t\"date_from\": \"2024-01-01\",\n\t\"date_to\": \"2024-01-31\",\n\t\"filter_by\": [\"sent_at\", \"opened_at\"]\n}",
  CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
    "authorization: Token <your_64_char_api_key>",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://<your_app_subdomain>.user.com/api/public/exports/"

payload = "{\n\t\"type\": \"email_delivery_logs\",\n\t\"date_from\": \"2024-01-01\",\n\t\"date_to\": \"2024-01-31\",\n\t\"filter_by\": [\"sent_at\", \"opened_at\"]\n}"
headers = {
    'authorization': "Token <your_64_char_api_key>",
    'Accept': "*/*; version=2",
    'content-type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)