cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/dashboards/{dashboard}/widgets/{widget}/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"days": 1830,
"from": "2023-12-25",
"to": "2023-12-25",
"locations": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"family": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"version": 2
}
'import requests
url = "https://app.stockshift.io/api/v1/insights/dashboards/{dashboard}/widgets/{widget}/run"
payload = {
"filters": {
"days": 1830,
"from": "2023-12-25",
"to": "2023-12-25",
"locations": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"family": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"version": 2
}
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/dashboards/{dashboard}/widgets/{widget}/run",
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([
'filters' => [
'days' => 1830,
'from' => '2023-12-25',
'to' => '2023-12-25',
'locations' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'family' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'version' => 2
]),
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/dashboards/{dashboard}/widgets/{widget}/run"
payload := strings.NewReader("{\n \"filters\": {\n \"days\": 1830,\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"locations\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"family\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"version\": 2\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>",
"type": "view",
"available": true,
"skipped": [
"<string>"
],
"title": "<string>",
"text": "<string>",
"report": {
"columns": [
{
"field": "<string>",
"label": "<string>",
"type": "text",
"role": "dimension",
"aggregation": "sum",
"grain": "day",
"unit_column": 123,
"currency": "<string>",
"pivoted": true,
"pivot_value": "<string>",
"previous": true
}
],
"rows": [
{
"kind": "detail",
"cells": [
"<string>"
],
"mixed_units": [
123
]
}
],
"totals": {
"kind": "detail",
"cells": [
"<string>"
],
"mixed_units": [
123
]
},
"next_page": 123,
"next_cursor": "<string>",
"limit": "rows",
"hidden": [
"<string>"
]
},
"chart": {
"type": "line",
"x_kind": "<string>",
"x_label": "<string>",
"panels": [
"<unknown>"
],
"categories": [
"<string>"
],
"y_type": "text",
"currency": "<string>",
"domain_from": 123,
"domain_to": 123,
"thinned": true,
"limit": "<string>",
"hidden": [
"<string>"
],
"more_series": 123
},
"kpi": {
"value": "<string>",
"type": "text",
"currency": "<string>",
"on": "<string>",
"previous": "<string>",
"change": 123,
"status": "good",
"direction": "higher",
"target": 123,
"grain": "<string>",
"series": [
"<unknown>"
]
},
"drill": "<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>"
]
}
]
}Paneles
Ejecuta un widget de panel
Calcula un widget de un panel como el miembro que lo pide, con los
filtros globales enviados en la solicitud. Un widget de vista se devuelve como su
gráfico o sus primeras filas. Un widget de KPI se devuelve con su valor frente a
su objetivo y sus umbrales. Una lista de excepciones se devuelve como sus primeras
filas. Un filtro global que el conjunto de datos del widget no admite no se
aplica y se lista en skipped. Un widget cuya vista o KPI ya no existe,
o cuyo conjunto de datos el miembro no puede leer, se devuelve con available en
false. Requiere el permiso insights.reports.view y un token con
insights:read.
POST
/
insights
/
dashboards
/
{dashboard}
/
widgets
/
{widget}
/
run
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/dashboards/{dashboard}/widgets/{widget}/run \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filters": {
"days": 1830,
"from": "2023-12-25",
"to": "2023-12-25",
"locations": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"family": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"version": 2
}
'import requests
url = "https://app.stockshift.io/api/v1/insights/dashboards/{dashboard}/widgets/{widget}/run"
payload = {
"filters": {
"days": 1830,
"from": "2023-12-25",
"to": "2023-12-25",
"locations": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"family": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"version": 2
}
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/dashboards/{dashboard}/widgets/{widget}/run",
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([
'filters' => [
'days' => 1830,
'from' => '2023-12-25',
'to' => '2023-12-25',
'locations' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'family' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'version' => 2
]),
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/dashboards/{dashboard}/widgets/{widget}/run"
payload := strings.NewReader("{\n \"filters\": {\n \"days\": 1830,\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"locations\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"family\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"version\": 2\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>",
"type": "view",
"available": true,
"skipped": [
"<string>"
],
"title": "<string>",
"text": "<string>",
"report": {
"columns": [
{
"field": "<string>",
"label": "<string>",
"type": "text",
"role": "dimension",
"aggregation": "sum",
"grain": "day",
"unit_column": 123,
"currency": "<string>",
"pivoted": true,
"pivot_value": "<string>",
"previous": true
}
],
"rows": [
{
"kind": "detail",
"cells": [
"<string>"
],
"mixed_units": [
123
]
}
],
"totals": {
"kind": "detail",
"cells": [
"<string>"
],
"mixed_units": [
123
]
},
"next_page": 123,
"next_cursor": "<string>",
"limit": "rows",
"hidden": [
"<string>"
]
},
"chart": {
"type": "line",
"x_kind": "<string>",
"x_label": "<string>",
"panels": [
"<unknown>"
],
"categories": [
"<string>"
],
"y_type": "text",
"currency": "<string>",
"domain_from": 123,
"domain_to": 123,
"thinned": true,
"limit": "<string>",
"hidden": [
"<string>"
],
"more_series": 123
},
"kpi": {
"value": "<string>",
"type": "text",
"currency": "<string>",
"on": "<string>",
"previous": "<string>",
"change": 123,
"status": "good",
"direction": "higher",
"target": 123,
"grain": "<string>",
"series": [
"<unknown>"
]
},
"drill": "<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.
Parámetros de ruta
El ID del panel, un UUID.
El ID del widget en el panel: de 1 a 40 letras, dígitos, guiones o guiones bajos.
Cuerpo
application/json
Los filtros globales bajo los que se ejecuta un widget del panel.
Los filtros globales: una cantidad de días o un rango de fechas fijo, ubicaciones y una familia de artículos. Un widget cuyo conjunto de datos no admite un filtro lo omite.
Show child attributes
Show child attributes
La versión del panel cuyo widget se ejecutará. La más reciente si se omite.
Rango requerido:
x >= 1Respuesta
WidgetResultResource
Un widget de panel calculado bajo los filtros globales.
Show child attributes
Show child attributes
¿Esta página le ayudó?