cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/reports/chart \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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
},
"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/reports/chart"
payload = {
"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
},
"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.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/reports/chart",
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([
'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
],
'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/reports/chart"
payload := strings.NewReader("{\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 \"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}")
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": {
"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
}
}{
"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>"
]
}
]
}Reportes
Dibuja un informe como gráfico
Ejecuta la definición de un reporte y la devuelve como las series que dibuja un gráfico. Cada
serie se reduce a un máximo de 2,000 puntos, y conserva sus puntos primero y último
y sus puntos más alto y más bajo. Toda la respuesta se mantiene por debajo de
200 KB, así que cada serie conserva menos puntos cuantas más series se agregan. Cuando
ni unos pocos puntos por serie caben, se omiten series y se
cuentan en more_series. Envía from y to, un rango del eje x, para
dibujar ese rango con más detalle. Los campos que el miembro no puede ver se omiten
y se listan en hidden. Requiere el permiso insights.reports.view
y un token con insights:read.
POST
/
insights
/
reports
/
chart
cURL
curl --request POST \
--url https://app.stockshift.io/api/v1/insights/reports/chart \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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
},
"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/reports/chart"
payload = {
"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
},
"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.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/reports/chart",
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([
'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
],
'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/reports/chart"
payload := strings.NewReader("{\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 \"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}")
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": {
"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
}
}{
"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.
Cuerpo
application/json
Un informe para dibujar como gráfico y cómo dibujarlo, con el rango del eje x al que acercar.
La definición del reporte: el conjunto de datos que se lee, los campos que se muestran y cómo filtrar, agrupar, pivotar, ordenar y totalizar sus filas.
Show child attributes
Show child attributes
Cómo se dibuja el reporte como gráfico: el tipo de gráfico y qué columnas van en cada eje.
Show child attributes
Show child attributes
El inicio de un rango ampliado del eje x: una fecha, una marca de tiempo ISO 8601 o un número.
Maximum string length:
40El final de un rango ampliado del eje x, en la misma forma que from.
Maximum string length:
40Respuesta
ChartResource
Un informe dibujado como gráfico.
Show child attributes
Show child attributes
¿Esta página le ayudó?