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>"
]
}
]
}Vues
Enregistrer une vue
Enregistre la définition d’un rapport et son mode d’affichage comme nouvelle vue privée. Avec l’ID d’une vue dans le chemin, enregistre une nouvelle version de cette vue et laisse chaque version antérieure inchangée. La définition est validée par rapport aux champs du jeu de données que le membre peut lire. Seul le propriétaire de la vue ou un membre ayant l’autorisation insights.reports.share peut la modifier. La modification est consignée dans l’historique d’audit. Nécessite l’autorisation insights.reports.manage et un jeton avec 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>"
]
}
]
}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 de la vue, un UUID. Omettez-le pour créer une nouvelle vue.
Corps
application/json
Un rapport à enregistrer comme vue, ou comme nouvelle version d'une vue. La définition est vérifiée comme pour une exécution, et l'affichage détermine comment la grille l'affiche.
Le nom de la vue, d'au plus 120 caractères, tel qu'affiché dans la liste des vues.
Maximum string length:
120La définition du rapport : le jeu de données à lire, les champs à afficher et comment filtrer, grouper, pivoter, trier et totaliser ses lignes.
Show child attributes
Show child attributes
Comment la grille affiche le rapport : ordre et largeur des colonnes, colonnes figées, décimales, mise en évidence et graphique.
Show child attributes
Show child attributes
À quoi répond la vue, en une phrase.
Maximum string length:
1000L'ID du dossier où la vue est conservée.
Réponse
ViewSavedResource
Une vue enregistrée telle qu'elle est après un enregistrement, une restauration ou un changement de partage. Lisez la vue par son ID pour le reste.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?