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>"
]
}
]
}Dashboards
Run a dashboard widget
Works one widget out as the person asking, under the global filters sent
with it. A view comes as its chart or its first rows. A KPI comes
against its target and thresholds, and an exceptions list as its first
rows. A global filter
a widget’s dataset cannot take is left out and listed in skipped. A
widget whose view or KPI is gone, or whose dataset the person may not
read, comes back with available false. Needs the insights.reports.view
permission and a token with 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>"
]
}
]
}Authorizations
apiKeyoauth2
For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.
Body
application/json
Response
WidgetResultResource
Show child attributes
Show child attributes
Was this page helpful?