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>"
]
}
]
}Exportaciones de Insights
Exporta un informe
Pone en cola la exportación de un reporte. Para exportar una vista guardada, envía view, y
version para una versión distinta de la más reciente. Para exportar un reporte que
no está guardado, envía definition como lo acepta el endpoint de ejecución y display,
que puede ser un objeto vacío. El formato es csv, xlsx, workbook o
pdf. xlsx es una exportación de datos de Excel de cualquier tamaño hasta el límite de filas
del plan. workbook es un libro de Excel con formato de hasta 50,000 filas con
un gráfico nativo y fórmulas vivas. La exportación se ejecuta con los permisos
que tiene el miembro cuando se ejecuta, y los campos que no puede ver nunca se
escriben en el archivo. Consulta la exportación, o suscríbete al webhook
insights.export.ready, para obtener el enlace a su archivo. El archivo se
conserva 72 horas. El cambio queda registrado en el historial de auditoría. Requiere el
permiso insights.reports.view y un token con 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>"
]
}
]
}Autorizaciones
apiKeyoauth2
Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.
Cuerpo
application/json
Un informe para exportar y el formato de archivo en que escribirlo. El informe es una vista guardada, que tiene su propia definición y presentación, o la definición de un informe tal como la recibe el endpoint de ejecutar informe, con la forma en que la cuadrícula lo muestra.
El formato de archivo: csv, xlsx para una exportación de datos de Excel de cualquier tamaño, workbook para un libro de Excel con formato de hasta 50,000 filas, o pdf.
Opciones disponibles:
csv, xlsx, workbook, pdf La definición del reporte: el conjunto de datos que se lee, los campos que se muestran y cómo filtrar, agrupar, pivotar, ordenar y totalizar sus filas.
Show child attributes
Show child attributes
Cómo muestra la cuadrícula el reporte: orden y anchos de columnas, columnas fijas, decimales, resaltado y el gráfico.
Show child attributes
Show child attributes
El ID de una vista guardada que se exporta. Omítelo para exportar la definition enviada con la solicitud.
La versión de la vista que se exporta. La más reciente si no se envía.
Rango requerido:
x >= 1El nombre que recibe el archivo cuando no hay vista.
Maximum string length:
120Respuesta
ExportResource
Una exportación de un informe: su estado y, cuando está lista, un enlace a su archivo.
Show child attributes
Show child attributes
¿Esta página le ayudó?