cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/insights/views/{view} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"definition": {
"dataset": "<string>",
"schema_version": "1",
"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/views/{view}"
payload = {
"name": "<string>",
"definition": {
"dataset": "<string>",
"schema_version": "1",
"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.put(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/views/{view}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'definition' => [
'dataset' => '<string>',
'schema_version' => '1',
'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/views/{view}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {\n \"dataset\": \"<string>\",\n \"schema_version\": \"1\",\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("PUT", 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>",
"name": "<string>",
"description": "<string>",
"dataset": "<string>",
"folder_id": "<string>",
"visibility": "private",
"roles": [
"<string>"
],
"version": 123,
"updated_at": "<string>"
}
}{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"dataset": "<string>",
"folder_id": "<string>",
"visibility": "private",
"roles": [
"<string>"
],
"version": 123,
"updated_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>"
]
}
]
}Views
Save a view
Saves a report definition and how it is shown as a new private view.
With a view’s id it saves a new version of it, which leaves every
earlier version as it was. The definition is checked as the person may read its
dataset. Changing a view needs being its owner or holding
insights.reports.share. Audited. Needs the insights.reports.manage
permission and a token with insights:write.
PUT
/
insights
/
views
/
{view}
cURL
curl --request PUT \
--url https://app.stockshift.io/api/v1/insights/views/{view} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"definition": {
"dataset": "<string>",
"schema_version": "1",
"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/views/{view}"
payload = {
"name": "<string>",
"definition": {
"dataset": "<string>",
"schema_version": "1",
"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.put(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/views/{view}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'definition' => [
'dataset' => '<string>',
'schema_version' => '1',
'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/views/{view}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"definition\": {\n \"dataset\": \"<string>\",\n \"schema_version\": \"1\",\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("PUT", 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>",
"name": "<string>",
"description": "<string>",
"dataset": "<string>",
"folder_id": "<string>",
"visibility": "private",
"roles": [
"<string>"
],
"version": 123,
"updated_at": "<string>"
}
}{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"dataset": "<string>",
"folder_id": "<string>",
"visibility": "private",
"roles": [
"<string>"
],
"version": 123,
"updated_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>"
]
}
]
}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.
Path Parameters
Body
application/json
A report to save as a view, or as a new version of one. The definition is checked as it is to run; the display says how the grid shows it.
What the view is called.
Maximum string length:
120Show child attributes
Show child attributes
How the grid shows it.
Show child attributes
Show child attributes
What it answers, in a sentence.
Maximum string length:
1000The folder it is kept in.
Response
ViewSavedResource
Show child attributes
Show child attributes
Was this page helpful?