cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"schema_version": "1",
"dataset": "<string>",
"joins": [
"<string>"
],
"fields": [
{
"field": "<string>",
"formula": "<string>",
"label": "<string>"
}
],
"filters": [
{
"field": "<string>",
"values": [
"<string>"
],
"range": {
"count": 500,
"from": "2023-12-25",
"to": "2023-12-25"
}
}
],
"group_by": [
{
"field": "<string>"
}
],
"pivot": {
"field": "<string>"
},
"sort": [
{
"field": "<string>"
}
],
"totals": true,
"subtotals": true,
"limit": 500000
},
"display": {
"columns": [
{
"key": "<string>",
"width": 524,
"hidden": true
}
],
"frozen": 2,
"formats": [
{
"key": "<string>",
"decimals": 3
}
],
"rules": [
{
"key": "<string>",
"value": "<string>",
"value2": "<string>"
}
],
"chart": {
"x": "<string>",
"y": [
"<string>"
],
"y2": [
"<string>"
],
"split": "<string>",
"multiples": "<string>",
"lower": "<string>",
"upper": "<string>"
}
}
}
'import requests
url = "https://app.stockshift.io/api/v1/insights/exports"
payload = {
"definition": {
"schema_version": "1",
"dataset": "<string>",
"joins": ["<string>"],
"fields": [
{
"field": "<string>",
"formula": "<string>",
"label": "<string>"
}
],
"filters": [
{
"field": "<string>",
"values": ["<string>"],
"range": {
"count": 500,
"from": "2023-12-25",
"to": "2023-12-25"
}
}
],
"group_by": [{ "field": "<string>" }],
"pivot": { "field": "<string>" },
"sort": [{ "field": "<string>" }],
"totals": True,
"subtotals": True,
"limit": 500000
},
"display": {
"columns": [
{
"key": "<string>",
"width": 524,
"hidden": True
}
],
"frozen": 2,
"formats": [
{
"key": "<string>",
"decimals": 3
}
],
"rules": [
{
"key": "<string>",
"value": "<string>",
"value2": "<string>"
}
],
"chart": {
"x": "<string>",
"y": ["<string>"],
"y2": ["<string>"],
"split": "<string>",
"multiples": "<string>",
"lower": "<string>",
"upper": "<string>"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/insights/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([
'definition' => [
'schema_version' => '1',
'dataset' => '<string>',
'joins' => [
'<string>'
],
'fields' => [
[
'field' => '<string>',
'formula' => '<string>',
'label' => '<string>'
]
],
'filters' => [
[
'field' => '<string>',
'values' => [
'<string>'
],
'range' => [
'count' => 500,
'from' => '2023-12-25',
'to' => '2023-12-25'
]
]
],
'group_by' => [
[
'field' => '<string>'
]
],
'pivot' => [
'field' => '<string>'
],
'sort' => [
[
'field' => '<string>'
]
],
'totals' => true,
'subtotals' => true,
'limit' => 500000
],
'display' => [
'columns' => [
[
'key' => '<string>',
'width' => 524,
'hidden' => true
]
],
'frozen' => 2,
'formats' => [
[
'key' => '<string>',
'decimals' => 3
]
],
'rules' => [
[
'key' => '<string>',
'value' => '<string>',
'value2' => '<string>'
]
],
'chart' => [
'x' => '<string>',
'y' => [
'<string>'
],
'y2' => [
'<string>'
],
'split' => '<string>',
'multiples' => '<string>',
'lower' => '<string>',
'upper' => '<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://app.stockshift.io/api/v1/insights/exports"
payload := strings.NewReader("{\n \"definition\": {\n \"schema_version\": \"1\",\n \"dataset\": \"<string>\",\n \"joins\": [\n \"<string>\"\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"formula\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"range\": {\n \"count\": 500,\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\"\n }\n }\n ],\n \"group_by\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"pivot\": {\n \"field\": \"<string>\"\n },\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"totals\": true,\n \"subtotals\": true,\n \"limit\": 500000\n },\n \"display\": {\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"width\": 524,\n \"hidden\": true\n }\n ],\n \"frozen\": 2,\n \"formats\": [\n {\n \"key\": \"<string>\",\n \"decimals\": 3\n }\n ],\n \"rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"value2\": \"<string>\"\n }\n ],\n \"chart\": {\n \"x\": \"<string>\",\n \"y\": [\n \"<string>\"\n ],\n \"y2\": [\n \"<string>\"\n ],\n \"split\": \"<string>\",\n \"multiples\": \"<string>\",\n \"lower\": \"<string>\",\n \"upper\": \"<string>\"\n }\n }\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))
}{
"data": {
"id": "<string>",
"format": "csv",
"status": "queued",
"file_name": "<string>",
"view_id": "<string>",
"view_version": 123,
"rows": 123,
"truncated": true,
"error": "<string>",
"expires_at": "<string>",
"expired": true,
"download_url": "<string>",
"created_at": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Exportations d'analyses
Exporter un rapport
Met en file d’attente l’exportation d’un rapport. Pour exporter une vue enregistrée, envoyez view, et
version pour une version autre que la plus récente. Pour exporter un rapport qui n’est
pas enregistré, envoyez definition comme le point de terminaison d’exécution l’accepte et display,
qui peut être un objet vide. Le format est csv, xlsx, workbook ou
pdf. xlsx est une exportation de données Excel de n’importe quelle taille jusqu’à la limite de lignes
du forfait. workbook est un classeur Excel mis en forme d’au plus 50,000 lignes avec
un graphique natif et des formules actives. L’exportation s’exécute avec les autorisations
que le membre a au moment de l’exécution, et les champs qu’il n’a pas le droit de voir ne sont jamais
écrits dans le fichier. Interrogez l’exportation, ou abonnez-vous au webhook
insights.export.ready, pour obtenir le lien vers son fichier. Le fichier est
conservé pendant 72 heures. La modification est consignée dans l’historique d’audit. Nécessite
l’autorisation insights.reports.view et un jeton avec insights:read.
POST
/
insights
/
exports
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"schema_version": "1",
"dataset": "<string>",
"joins": [
"<string>"
],
"fields": [
{
"field": "<string>",
"formula": "<string>",
"label": "<string>"
}
],
"filters": [
{
"field": "<string>",
"values": [
"<string>"
],
"range": {
"count": 500,
"from": "2023-12-25",
"to": "2023-12-25"
}
}
],
"group_by": [
{
"field": "<string>"
}
],
"pivot": {
"field": "<string>"
},
"sort": [
{
"field": "<string>"
}
],
"totals": true,
"subtotals": true,
"limit": 500000
},
"display": {
"columns": [
{
"key": "<string>",
"width": 524,
"hidden": true
}
],
"frozen": 2,
"formats": [
{
"key": "<string>",
"decimals": 3
}
],
"rules": [
{
"key": "<string>",
"value": "<string>",
"value2": "<string>"
}
],
"chart": {
"x": "<string>",
"y": [
"<string>"
],
"y2": [
"<string>"
],
"split": "<string>",
"multiples": "<string>",
"lower": "<string>",
"upper": "<string>"
}
}
}
'import requests
url = "https://app.stockshift.io/api/v1/insights/exports"
payload = {
"definition": {
"schema_version": "1",
"dataset": "<string>",
"joins": ["<string>"],
"fields": [
{
"field": "<string>",
"formula": "<string>",
"label": "<string>"
}
],
"filters": [
{
"field": "<string>",
"values": ["<string>"],
"range": {
"count": 500,
"from": "2023-12-25",
"to": "2023-12-25"
}
}
],
"group_by": [{ "field": "<string>" }],
"pivot": { "field": "<string>" },
"sort": [{ "field": "<string>" }],
"totals": True,
"subtotals": True,
"limit": 500000
},
"display": {
"columns": [
{
"key": "<string>",
"width": 524,
"hidden": True
}
],
"frozen": 2,
"formats": [
{
"key": "<string>",
"decimals": 3
}
],
"rules": [
{
"key": "<string>",
"value": "<string>",
"value2": "<string>"
}
],
"chart": {
"x": "<string>",
"y": ["<string>"],
"y2": ["<string>"],
"split": "<string>",
"multiples": "<string>",
"lower": "<string>",
"upper": "<string>"
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.stockshift.io/api/v1/insights/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([
'definition' => [
'schema_version' => '1',
'dataset' => '<string>',
'joins' => [
'<string>'
],
'fields' => [
[
'field' => '<string>',
'formula' => '<string>',
'label' => '<string>'
]
],
'filters' => [
[
'field' => '<string>',
'values' => [
'<string>'
],
'range' => [
'count' => 500,
'from' => '2023-12-25',
'to' => '2023-12-25'
]
]
],
'group_by' => [
[
'field' => '<string>'
]
],
'pivot' => [
'field' => '<string>'
],
'sort' => [
[
'field' => '<string>'
]
],
'totals' => true,
'subtotals' => true,
'limit' => 500000
],
'display' => [
'columns' => [
[
'key' => '<string>',
'width' => 524,
'hidden' => true
]
],
'frozen' => 2,
'formats' => [
[
'key' => '<string>',
'decimals' => 3
]
],
'rules' => [
[
'key' => '<string>',
'value' => '<string>',
'value2' => '<string>'
]
],
'chart' => [
'x' => '<string>',
'y' => [
'<string>'
],
'y2' => [
'<string>'
],
'split' => '<string>',
'multiples' => '<string>',
'lower' => '<string>',
'upper' => '<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://app.stockshift.io/api/v1/insights/exports"
payload := strings.NewReader("{\n \"definition\": {\n \"schema_version\": \"1\",\n \"dataset\": \"<string>\",\n \"joins\": [\n \"<string>\"\n ],\n \"fields\": [\n {\n \"field\": \"<string>\",\n \"formula\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"values\": [\n \"<string>\"\n ],\n \"range\": {\n \"count\": 500,\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\"\n }\n }\n ],\n \"group_by\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"pivot\": {\n \"field\": \"<string>\"\n },\n \"sort\": [\n {\n \"field\": \"<string>\"\n }\n ],\n \"totals\": true,\n \"subtotals\": true,\n \"limit\": 500000\n },\n \"display\": {\n \"columns\": [\n {\n \"key\": \"<string>\",\n \"width\": 524,\n \"hidden\": true\n }\n ],\n \"frozen\": 2,\n \"formats\": [\n {\n \"key\": \"<string>\",\n \"decimals\": 3\n }\n ],\n \"rules\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"value2\": \"<string>\"\n }\n ],\n \"chart\": {\n \"x\": \"<string>\",\n \"y\": [\n \"<string>\"\n ],\n \"y2\": [\n \"<string>\"\n ],\n \"split\": \"<string>\",\n \"multiples\": \"<string>\",\n \"lower\": \"<string>\",\n \"upper\": \"<string>\"\n }\n }\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))
}{
"data": {
"id": "<string>",
"format": "csv",
"status": "queued",
"file_name": "<string>",
"view_id": "<string>",
"view_version": 123,
"rows": 123,
"truncated": true,
"error": "<string>",
"expires_at": "<string>",
"expired": true,
"download_url": "<string>",
"created_at": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"errors": {},
"feature": "<string>",
"reason": "<string>",
"attempts_left": 123,
"rule_ids": [
"<string>"
],
"witness": "<string>",
"blind_recount": true,
"flags": [
{
"flag": "<string>",
"facts": {},
"choices": [
"<string>"
]
}
]
}Autorisations
apiKeyoauth2
Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.
Corps
application/json
Un rapport à exporter et le format de fichier à écrire. Le rapport est soit une vue enregistrée, qui a sa propre définition et son propre affichage, soit une définition de rapport telle que l'accepte le point de terminaison d'exécution de rapport, avec la manière dont la grille l'affiche.
Le format de fichier : csv, xlsx pour une exportation de données Excel de toute taille, workbook pour un classeur Excel mis en forme d'au plus 50,000 lignes, ou pdf.
Options disponibles:
csv, xlsx, workbook, pdf La définition du rapport : le jeu de données à lire, les champs à afficher et comment filtrer, grouper, pivoter, trier et totaliser ses lignes.
Show child attributes
Show child attributes
Comment la grille affiche le rapport : ordre et largeur des colonnes, colonnes figées, décimales, mise en évidence et graphique.
Show child attributes
Show child attributes
L'ID d'une vue enregistrée à exporter. Omettez-le pour exporter la definition envoyée avec la requête.
La version de la vue à exporter. La plus récente si elle est omise.
Plage requise:
x >= 1Le nom donné au fichier lorsqu'il n'y a pas de vue.
Maximum string length:
120Réponse
ExportResource
Une exportation de rapport : son statut et, une fois prête, un lien vers son fichier.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?