Preview a query
curl --request POST \
--url https://api.statisfy.com/v1/integrations/{key}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": {
"name": "<string>",
"sql": "<string>",
"account_resolver": {
"column": "<string>",
"abbreviations": {},
"custom_field_key": "<string>",
"cutoff": 123,
"exclude_keywords": [
"<string>"
],
"field_to_parse": "<string>",
"value_transform": {
"regex_extract": "<string>",
"skip_if_contains": "<string>",
"skip_if_equals": "<string>",
"split_first_token": "<string>",
"strip_prefix": "<string>"
}
},
"custom_field_mappings": [
{
"key": "<string>",
"source_column": "<string>"
}
],
"custom_object_config": {
"external_id_column": "<string>",
"field_mappings": [
{
"field_label": "<string>",
"key": "<string>",
"source_column": "<string>"
}
],
"key": "<string>",
"name": "<string>"
},
"entity_type": "account",
"group_by_columns": [
"<string>"
],
"is_active": true,
"limit": 2,
"order_by_columns": [
"<string>"
],
"person_resolver": {
"email_column": "<string>",
"alias_domains": [
"<string>"
],
"create_missing_people": true,
"first_name_column": "<string>",
"last_name_column": "<string>",
"name_column": "<string>",
"tenant_domain": "<string>"
},
"product_usage_mappings": [
{
"metric_name": "<string>",
"source_column": "<string>",
"value_type": "int"
}
],
"transformers": [
{
"source_column": "<string>",
"steps": [
{
"mapping": {},
"delimiter": "<string>",
"keep_unmapped": true,
"type": "lookup"
}
],
"target_column": "<string>"
}
]
},
"query_id": "<string>"
}
'import requests
url = "https://api.statisfy.com/v1/integrations/{key}/preview"
payload = {
"query": {
"name": "<string>",
"sql": "<string>",
"account_resolver": {
"column": "<string>",
"abbreviations": {},
"custom_field_key": "<string>",
"cutoff": 123,
"exclude_keywords": ["<string>"],
"field_to_parse": "<string>",
"value_transform": {
"regex_extract": "<string>",
"skip_if_contains": "<string>",
"skip_if_equals": "<string>",
"split_first_token": "<string>",
"strip_prefix": "<string>"
}
},
"custom_field_mappings": [
{
"key": "<string>",
"source_column": "<string>"
}
],
"custom_object_config": {
"external_id_column": "<string>",
"field_mappings": [
{
"field_label": "<string>",
"key": "<string>",
"source_column": "<string>"
}
],
"key": "<string>",
"name": "<string>"
},
"entity_type": "account",
"group_by_columns": ["<string>"],
"is_active": True,
"limit": 2,
"order_by_columns": ["<string>"],
"person_resolver": {
"email_column": "<string>",
"alias_domains": ["<string>"],
"create_missing_people": True,
"first_name_column": "<string>",
"last_name_column": "<string>",
"name_column": "<string>",
"tenant_domain": "<string>"
},
"product_usage_mappings": [
{
"metric_name": "<string>",
"source_column": "<string>",
"value_type": "int"
}
],
"transformers": [
{
"source_column": "<string>",
"steps": [
{
"mapping": {},
"delimiter": "<string>",
"keep_unmapped": True,
"type": "lookup"
}
],
"target_column": "<string>"
}
]
},
"query_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: {
name: '<string>',
sql: '<string>',
account_resolver: {
column: '<string>',
abbreviations: {},
custom_field_key: '<string>',
cutoff: 123,
exclude_keywords: ['<string>'],
field_to_parse: '<string>',
value_transform: {
regex_extract: '<string>',
skip_if_contains: '<string>',
skip_if_equals: '<string>',
split_first_token: '<string>',
strip_prefix: '<string>'
}
},
custom_field_mappings: [{key: '<string>', source_column: '<string>'}],
custom_object_config: {
external_id_column: '<string>',
field_mappings: [{field_label: '<string>', key: '<string>', source_column: '<string>'}],
key: '<string>',
name: '<string>'
},
entity_type: 'account',
group_by_columns: ['<string>'],
is_active: true,
limit: 2,
order_by_columns: ['<string>'],
person_resolver: {
email_column: '<string>',
alias_domains: ['<string>'],
create_missing_people: true,
first_name_column: '<string>',
last_name_column: '<string>',
name_column: '<string>',
tenant_domain: '<string>'
},
product_usage_mappings: [{metric_name: '<string>', source_column: '<string>', value_type: 'int'}],
transformers: [
{
source_column: '<string>',
steps: [{mapping: {}, delimiter: '<string>', keep_unmapped: true, type: 'lookup'}],
target_column: '<string>'
}
]
},
query_id: '<string>'
})
};
fetch('https://api.statisfy.com/v1/integrations/{key}/preview', 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.statisfy.com/v1/integrations/{key}/preview",
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([
'query' => [
'name' => '<string>',
'sql' => '<string>',
'account_resolver' => [
'column' => '<string>',
'abbreviations' => [
],
'custom_field_key' => '<string>',
'cutoff' => 123,
'exclude_keywords' => [
'<string>'
],
'field_to_parse' => '<string>',
'value_transform' => [
'regex_extract' => '<string>',
'skip_if_contains' => '<string>',
'skip_if_equals' => '<string>',
'split_first_token' => '<string>',
'strip_prefix' => '<string>'
]
],
'custom_field_mappings' => [
[
'key' => '<string>',
'source_column' => '<string>'
]
],
'custom_object_config' => [
'external_id_column' => '<string>',
'field_mappings' => [
[
'field_label' => '<string>',
'key' => '<string>',
'source_column' => '<string>'
]
],
'key' => '<string>',
'name' => '<string>'
],
'entity_type' => 'account',
'group_by_columns' => [
'<string>'
],
'is_active' => true,
'limit' => 2,
'order_by_columns' => [
'<string>'
],
'person_resolver' => [
'email_column' => '<string>',
'alias_domains' => [
'<string>'
],
'create_missing_people' => true,
'first_name_column' => '<string>',
'last_name_column' => '<string>',
'name_column' => '<string>',
'tenant_domain' => '<string>'
],
'product_usage_mappings' => [
[
'metric_name' => '<string>',
'source_column' => '<string>',
'value_type' => 'int'
]
],
'transformers' => [
[
'source_column' => '<string>',
'steps' => [
[
'mapping' => [
],
'delimiter' => '<string>',
'keep_unmapped' => true,
'type' => 'lookup'
]
],
'target_column' => '<string>'
]
]
],
'query_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.statisfy.com/v1/integrations/{key}/preview"
payload := strings.NewReader("{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.statisfy.com/v1/integrations/{key}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/integrations/{key}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"duration_ms": 123,
"invalid": 123,
"matched": 123,
"rows_read": 123,
"samples": [
{
"entity_id": "<string>",
"external_id": "<string>",
"skipped": {},
"values": {}
}
],
"truncated": true,
"unmatched": 123,
"unmatched_samples": [
"<unknown>"
],
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}integrations
Preview a query
A dry run: runs a saved query (query_id) or a draft (query) as a run would now, on up to 1,000 rows, and says what it would write, writing nothing. Each row goes through the query’s transformers and account (or person) lookup: you get how many matched, up to 10 values that matched no account, and up to 10 rows with the values they would write. A people query never creates people here. Use it to check a resolver and mappings before saving or running. Same limits as /sql.
POST
/
v1
/
integrations
/
{key}
/
preview
Preview a query
curl --request POST \
--url https://api.statisfy.com/v1/integrations/{key}/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": {
"name": "<string>",
"sql": "<string>",
"account_resolver": {
"column": "<string>",
"abbreviations": {},
"custom_field_key": "<string>",
"cutoff": 123,
"exclude_keywords": [
"<string>"
],
"field_to_parse": "<string>",
"value_transform": {
"regex_extract": "<string>",
"skip_if_contains": "<string>",
"skip_if_equals": "<string>",
"split_first_token": "<string>",
"strip_prefix": "<string>"
}
},
"custom_field_mappings": [
{
"key": "<string>",
"source_column": "<string>"
}
],
"custom_object_config": {
"external_id_column": "<string>",
"field_mappings": [
{
"field_label": "<string>",
"key": "<string>",
"source_column": "<string>"
}
],
"key": "<string>",
"name": "<string>"
},
"entity_type": "account",
"group_by_columns": [
"<string>"
],
"is_active": true,
"limit": 2,
"order_by_columns": [
"<string>"
],
"person_resolver": {
"email_column": "<string>",
"alias_domains": [
"<string>"
],
"create_missing_people": true,
"first_name_column": "<string>",
"last_name_column": "<string>",
"name_column": "<string>",
"tenant_domain": "<string>"
},
"product_usage_mappings": [
{
"metric_name": "<string>",
"source_column": "<string>",
"value_type": "int"
}
],
"transformers": [
{
"source_column": "<string>",
"steps": [
{
"mapping": {},
"delimiter": "<string>",
"keep_unmapped": true,
"type": "lookup"
}
],
"target_column": "<string>"
}
]
},
"query_id": "<string>"
}
'import requests
url = "https://api.statisfy.com/v1/integrations/{key}/preview"
payload = {
"query": {
"name": "<string>",
"sql": "<string>",
"account_resolver": {
"column": "<string>",
"abbreviations": {},
"custom_field_key": "<string>",
"cutoff": 123,
"exclude_keywords": ["<string>"],
"field_to_parse": "<string>",
"value_transform": {
"regex_extract": "<string>",
"skip_if_contains": "<string>",
"skip_if_equals": "<string>",
"split_first_token": "<string>",
"strip_prefix": "<string>"
}
},
"custom_field_mappings": [
{
"key": "<string>",
"source_column": "<string>"
}
],
"custom_object_config": {
"external_id_column": "<string>",
"field_mappings": [
{
"field_label": "<string>",
"key": "<string>",
"source_column": "<string>"
}
],
"key": "<string>",
"name": "<string>"
},
"entity_type": "account",
"group_by_columns": ["<string>"],
"is_active": True,
"limit": 2,
"order_by_columns": ["<string>"],
"person_resolver": {
"email_column": "<string>",
"alias_domains": ["<string>"],
"create_missing_people": True,
"first_name_column": "<string>",
"last_name_column": "<string>",
"name_column": "<string>",
"tenant_domain": "<string>"
},
"product_usage_mappings": [
{
"metric_name": "<string>",
"source_column": "<string>",
"value_type": "int"
}
],
"transformers": [
{
"source_column": "<string>",
"steps": [
{
"mapping": {},
"delimiter": "<string>",
"keep_unmapped": True,
"type": "lookup"
}
],
"target_column": "<string>"
}
]
},
"query_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
query: {
name: '<string>',
sql: '<string>',
account_resolver: {
column: '<string>',
abbreviations: {},
custom_field_key: '<string>',
cutoff: 123,
exclude_keywords: ['<string>'],
field_to_parse: '<string>',
value_transform: {
regex_extract: '<string>',
skip_if_contains: '<string>',
skip_if_equals: '<string>',
split_first_token: '<string>',
strip_prefix: '<string>'
}
},
custom_field_mappings: [{key: '<string>', source_column: '<string>'}],
custom_object_config: {
external_id_column: '<string>',
field_mappings: [{field_label: '<string>', key: '<string>', source_column: '<string>'}],
key: '<string>',
name: '<string>'
},
entity_type: 'account',
group_by_columns: ['<string>'],
is_active: true,
limit: 2,
order_by_columns: ['<string>'],
person_resolver: {
email_column: '<string>',
alias_domains: ['<string>'],
create_missing_people: true,
first_name_column: '<string>',
last_name_column: '<string>',
name_column: '<string>',
tenant_domain: '<string>'
},
product_usage_mappings: [{metric_name: '<string>', source_column: '<string>', value_type: 'int'}],
transformers: [
{
source_column: '<string>',
steps: [{mapping: {}, delimiter: '<string>', keep_unmapped: true, type: 'lookup'}],
target_column: '<string>'
}
]
},
query_id: '<string>'
})
};
fetch('https://api.statisfy.com/v1/integrations/{key}/preview', 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.statisfy.com/v1/integrations/{key}/preview",
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([
'query' => [
'name' => '<string>',
'sql' => '<string>',
'account_resolver' => [
'column' => '<string>',
'abbreviations' => [
],
'custom_field_key' => '<string>',
'cutoff' => 123,
'exclude_keywords' => [
'<string>'
],
'field_to_parse' => '<string>',
'value_transform' => [
'regex_extract' => '<string>',
'skip_if_contains' => '<string>',
'skip_if_equals' => '<string>',
'split_first_token' => '<string>',
'strip_prefix' => '<string>'
]
],
'custom_field_mappings' => [
[
'key' => '<string>',
'source_column' => '<string>'
]
],
'custom_object_config' => [
'external_id_column' => '<string>',
'field_mappings' => [
[
'field_label' => '<string>',
'key' => '<string>',
'source_column' => '<string>'
]
],
'key' => '<string>',
'name' => '<string>'
],
'entity_type' => 'account',
'group_by_columns' => [
'<string>'
],
'is_active' => true,
'limit' => 2,
'order_by_columns' => [
'<string>'
],
'person_resolver' => [
'email_column' => '<string>',
'alias_domains' => [
'<string>'
],
'create_missing_people' => true,
'first_name_column' => '<string>',
'last_name_column' => '<string>',
'name_column' => '<string>',
'tenant_domain' => '<string>'
],
'product_usage_mappings' => [
[
'metric_name' => '<string>',
'source_column' => '<string>',
'value_type' => 'int'
]
],
'transformers' => [
[
'source_column' => '<string>',
'steps' => [
[
'mapping' => [
],
'delimiter' => '<string>',
'keep_unmapped' => true,
'type' => 'lookup'
]
],
'target_column' => '<string>'
]
]
],
'query_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.statisfy.com/v1/integrations/{key}/preview"
payload := strings.NewReader("{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.statisfy.com/v1/integrations/{key}/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/integrations/{key}/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"account_resolver\": {\n \"column\": \"<string>\",\n \"abbreviations\": {},\n \"custom_field_key\": \"<string>\",\n \"cutoff\": 123,\n \"exclude_keywords\": [\n \"<string>\"\n ],\n \"field_to_parse\": \"<string>\",\n \"value_transform\": {\n \"regex_extract\": \"<string>\",\n \"skip_if_contains\": \"<string>\",\n \"skip_if_equals\": \"<string>\",\n \"split_first_token\": \"<string>\",\n \"strip_prefix\": \"<string>\"\n }\n },\n \"custom_field_mappings\": [\n {\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"custom_object_config\": {\n \"external_id_column\": \"<string>\",\n \"field_mappings\": [\n {\n \"field_label\": \"<string>\",\n \"key\": \"<string>\",\n \"source_column\": \"<string>\"\n }\n ],\n \"key\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"entity_type\": \"account\",\n \"group_by_columns\": [\n \"<string>\"\n ],\n \"is_active\": true,\n \"limit\": 2,\n \"order_by_columns\": [\n \"<string>\"\n ],\n \"person_resolver\": {\n \"email_column\": \"<string>\",\n \"alias_domains\": [\n \"<string>\"\n ],\n \"create_missing_people\": true,\n \"first_name_column\": \"<string>\",\n \"last_name_column\": \"<string>\",\n \"name_column\": \"<string>\",\n \"tenant_domain\": \"<string>\"\n },\n \"product_usage_mappings\": [\n {\n \"metric_name\": \"<string>\",\n \"source_column\": \"<string>\",\n \"value_type\": \"int\"\n }\n ],\n \"transformers\": [\n {\n \"source_column\": \"<string>\",\n \"steps\": [\n {\n \"mapping\": {},\n \"delimiter\": \"<string>\",\n \"keep_unmapped\": true,\n \"type\": \"lookup\"\n }\n ],\n \"target_column\": \"<string>\"\n }\n ]\n },\n \"query_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"duration_ms": 123,
"invalid": 123,
"matched": 123,
"rows_read": 123,
"samples": [
{
"entity_id": "<string>",
"external_id": "<string>",
"skipped": {},
"values": {}
}
],
"truncated": true,
"unmatched": 123,
"unmatched_samples": [
"<unknown>"
],
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
application/json
Response
200 - application/json
Successful Response
Was this page helpful?