Create a report
curl --request POST \
--url https://api.extole.io/v4/reports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "display_name",
"format": "CSV",
"formats": [
"CSV"
],
"name": "name",
"parameters": {
"parameters_key": "parameters_key"
},
"report_type": "report_type",
"rerun": true,
"scopes": [
"CLIENT_ADMIN"
],
"sftp_report_name": "sftp_report_name",
"sftp_server_id": "sftp_server_id",
"tags": [
"tag"
]
}
'import requests
url = "https://api.extole.io/v4/reports"
payload = {
"display_name": "display_name",
"format": "CSV",
"formats": ["CSV"],
"name": "name",
"parameters": { "parameters_key": "parameters_key" },
"report_type": "report_type",
"rerun": True,
"scopes": ["CLIENT_ADMIN"],
"sftp_report_name": "sftp_report_name",
"sftp_server_id": "sftp_server_id",
"tags": ["tag"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'display_name',
format: 'CSV',
formats: ['CSV'],
name: 'name',
parameters: {parameters_key: 'parameters_key'},
report_type: 'report_type',
rerun: true,
scopes: ['CLIENT_ADMIN'],
sftp_report_name: 'sftp_report_name',
sftp_server_id: 'sftp_server_id',
tags: ['tag']
})
};
fetch('https://api.extole.io/v4/reports', 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.extole.io/v4/reports",
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([
'display_name' => 'display_name',
'format' => 'CSV',
'formats' => [
'CSV'
],
'name' => 'name',
'parameters' => [
'parameters_key' => 'parameters_key'
],
'report_type' => 'report_type',
'rerun' => true,
'scopes' => [
'CLIENT_ADMIN'
],
'sftp_report_name' => 'sftp_report_name',
'sftp_server_id' => 'sftp_server_id',
'tags' => [
'tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v4/reports"
payload := strings.NewReader("{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.extole.io/v4/reports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v4/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"completed_date": "<string>",
"display_name": "<string>",
"download_uri": "<string>",
"formats": [],
"name": "<string>",
"report_id": "<string>",
"report_type": "<string>",
"tags": [
"<string>"
]
}Reports
Create a report
Submits a new report run for the specified report type and parameters. The report executes asynchronously; poll the returned report ID to check status.
POST
/
v4
/
reports
Create a report
curl --request POST \
--url https://api.extole.io/v4/reports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "display_name",
"format": "CSV",
"formats": [
"CSV"
],
"name": "name",
"parameters": {
"parameters_key": "parameters_key"
},
"report_type": "report_type",
"rerun": true,
"scopes": [
"CLIENT_ADMIN"
],
"sftp_report_name": "sftp_report_name",
"sftp_server_id": "sftp_server_id",
"tags": [
"tag"
]
}
'import requests
url = "https://api.extole.io/v4/reports"
payload = {
"display_name": "display_name",
"format": "CSV",
"formats": ["CSV"],
"name": "name",
"parameters": { "parameters_key": "parameters_key" },
"report_type": "report_type",
"rerun": True,
"scopes": ["CLIENT_ADMIN"],
"sftp_report_name": "sftp_report_name",
"sftp_server_id": "sftp_server_id",
"tags": ["tag"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'display_name',
format: 'CSV',
formats: ['CSV'],
name: 'name',
parameters: {parameters_key: 'parameters_key'},
report_type: 'report_type',
rerun: true,
scopes: ['CLIENT_ADMIN'],
sftp_report_name: 'sftp_report_name',
sftp_server_id: 'sftp_server_id',
tags: ['tag']
})
};
fetch('https://api.extole.io/v4/reports', 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.extole.io/v4/reports",
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([
'display_name' => 'display_name',
'format' => 'CSV',
'formats' => [
'CSV'
],
'name' => 'name',
'parameters' => [
'parameters_key' => 'parameters_key'
],
'report_type' => 'report_type',
'rerun' => true,
'scopes' => [
'CLIENT_ADMIN'
],
'sftp_report_name' => 'sftp_report_name',
'sftp_server_id' => 'sftp_server_id',
'tags' => [
'tag'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.extole.io/v4/reports"
payload := strings.NewReader("{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.extole.io/v4/reports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v4/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"display_name\",\n \"format\": \"CSV\",\n \"formats\": [\n \"CSV\"\n ],\n \"name\": \"name\",\n \"parameters\": {\n \"parameters_key\": \"parameters_key\"\n },\n \"report_type\": \"report_type\",\n \"rerun\": true,\n \"scopes\": [\n \"CLIENT_ADMIN\"\n ],\n \"sftp_report_name\": \"sftp_report_name\",\n \"sftp_server_id\": \"sftp_server_id\",\n \"tags\": [\n \"tag\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"completed_date": "<string>",
"display_name": "<string>",
"download_uri": "<string>",
"formats": [],
"name": "<string>",
"report_id": "<string>",
"report_type": "<string>",
"tags": [
"<string>"
]
}Authorizations
HEADERQUERYCOOKIE
Body
application/json
Available options:
CSV, HEADLESS_CSV, HEADLESS_PSV, JSON, JSONL, PSV, XLSX Available options:
CSV, HEADLESS_CSV, HEADLESS_PSV, JSON, JSONL, PSV, XLSX Show child attributes
Show child attributes
Available options:
CLIENT_ADMIN, CLIENT_SUPERUSER, CONSUMER_PUBLIC Response
Successful response
⌘I
