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>"
]
}
]
}Tableaux de bord
Exécuter un widget de tableau de bord
Calcule un widget d’un tableau de bord en tant que membre qui le demande, sous les
filtres globaux envoyés avec la requête. Un widget de vue revient sous forme de
graphique ou de premières lignes. Un widget de KPI revient avec sa valeur par rapport à
sa cible et à ses seuils. Une liste d’exceptions revient sous forme de premières
lignes. Un filtre global que le jeu de données du widget ne peut pas accepter n’est pas
appliqué et figure dans skipped. Un widget dont la vue ou le KPI n’existe plus,
ou dont le membre n’a pas le droit de lire le jeu de données, revient avec available défini
à false. Nécessite l’autorisation insights.reports.view et un jeton avec
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>"
]
}
]
}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.
Paramètres de chemin
L'ID du tableau de bord, un UUID.
L'ID du widget sur le tableau de bord : 1 à 40 lettres, chiffres, traits d'union ou traits de soulignement.
Corps
application/json
Les filtres globaux sous lesquels exécuter un widget de tableau de bord.
Les filtres globaux : un nombre de jours ou une plage de dates fixe, des emplacements et une famille d'articles. Un widget dont le jeu de données ne peut pas accepter un filtre l'ignore.
Show child attributes
Show child attributes
La version du tableau de bord dont il faut exécuter le widget. La plus récente si elle est omise.
Plage requise:
x >= 1Réponse
WidgetResultResource
Un widget de tableau de bord calculé selon les filtres globaux.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?