DeforaNetworks/corteza
DeforaNetworks/corteza
3
0
Fork 0
Code

Added example JSON for charts API calls

Browse Source
This commit is contained in:
crustcrm1 2018-11-12 12:14:49 +01:00
parent a4a144c786
commit 21b4e366fc
5 changed files with 226 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
crm/docs/Chart-API.md
View File

@ -10,10 +10,21 @@ Example chart: select Opportunity value for all opportunities between 1/1/2018 a
{
"kind": "line",
"data": [
["Close date", "2018-01-01", "2018-01-02", "2018-01-03", "2018-01-04"],
["Opportunity value", 30, 200, 100, 400]
[
"Close date",
"2018-01-01",
"2018-01-02",
"2018-01-03",
"2018-01-04"
],
[
"Opportunity value",
30,
200,
100,
400
]
,
],
"fields": {
"Close date": {
"kind": "datetime",
@ -24,6 +35,16 @@ Example chart: select Opportunity value for all opportunities between 1/1/2018 a
"name": "(Field name)",
"kind": "(Field kind)"
}
},
"meta": {
"name": "Line chart",
"description": "Description for the chart",
"kind": "line",
"module": 62511111111111110,
"x": 62522222222222220,
"xmin": "1/1/2018",
"xmax": "31/12/2018",
"y": 62533333333333336
}
}
```
@ -42,15 +63,32 @@ Lost, 2
{
"kind": "pie",
"data": [
["Open", 10],
["Won", 5],
["Lost", 2]
[
"Open",
10
],
[
"Won",
5
],
[
"Lost",
2
]
,
],
"fields": {
"state": {
"kind": "string",
"kind": "string"
}
},
"meta": {
"name": "Pie chart",
"description": "",
"kind": "pie",
"module": 62511111111111110,
"x": 62522222222222220,
"y": 62533333333333336,
"count": 62566666666666664
}
}
```
@ -65,15 +103,32 @@ This will need to return a sum of all the opportunies by type (very similar to c
{
"kind": "donut",
"data": [
["Open", 120000],
["Won", 1000000],
["Lost", 30000]
[
"Open",
120000
],
[
"Won",
1000000
],
[
"Lost",
30000
]
,
],
"fields": {
"type": {
"kind": "string",
"kind": "string"
}
},
"meta": {
"name": "Donut chart",
"description": "Description for the chart",
"kind": "donut",
"module": 62511111111111110,
"x": 62522222222222220,
"y": 62533333333333336,
"sum": 62555555555555550
}
}
```
@ -86,17 +141,41 @@ Example bar chart with number of leads per country: select lead.country from lea
{
"kind": "bar",
"data": [
["France", 12],
["Slovenia", 10],
["Spain", 3],
["United Kingdom", 5],
["Germany", 20']
[
"France",
12
],
[
"Slovenia",
10
],
[
"Spain",
3
],
[
"United Kingdom",
5
],
[
"Germany",
20
]
,
],
"fields": {
"country": {
"kind": "string",
"kind": "string"
}
},
"meta": {
"name": "Bar chart",
"description": "",
"kind": "bar",
"module": 62511111111111110,
"x": 62522222222222220,
"y": 62533333333333336,
"groupby": 62544444444444450,
"count": 62566666666666664
}
}
```

16
crm/docs/api/chart-bar.json Normal file
View File

@ -0,0 +1,16 @@
{
"kind": "bar",
"data": [
["France", 12],
["Slovenia", 10],
["Spain", 3],
["United Kingdom", 5],
["Germany", 20]
]
,
"fields": {
"country": {
"kind": "string",
}
}
}

40
crm/docs/api/chart-donut.json Normal file
View File

@ -0,0 +1,40 @@
{
"kind": "bar",
"data": [
[
"France",
12
],
[
"Slovenia",
10
],
[
"Spain",
3
],
[
"United Kingdom",
5
],
[
"Germany",
20
]
],
"fields": {
"country": {
"kind": "string"
}
},
"meta": {
"name": "Bar chart",
"description": "",
"kind": "bar",
"module": 62511111111111110,
"x": 62522222222222220,
"y": 62533333333333336,
"groupby": 62544444444444450,
"count": 62566666666666664
}
}

40
crm/docs/api/chart-line.json Normal file
View File

@ -0,0 +1,40 @@
{
"kind": "line",
"data": [
[
"Close date",
"2018-01-01",
"2018-01-02",
"2018-01-03",
"2018-01-04"
],
[
"Opportunity value",
30,
200,
100,
400
]
],
"fields": {
"Close date": {
"kind": "datetime",
"min": "1/1/2018",
"max": "31/12/2018"
},
"Opportunity value": {
"name": "(Field name)",
"kind": "(Field kind)"
}
},
"meta": {
"name": "Line chart",
"description": "Description for the chart",
"kind": "line",
"module": 62511111111111110,
"x": 62522222222222220,
"xmin": "1/1/2018",
"xmax": "31/12/2018",
"y": 62533333333333336
}
}

31
crm/docs/api/chart-pie.json Normal file
View File

@ -0,0 +1,31 @@
{
"kind": "pie",
"data": [
[
"Open",
10
],
[
"Won",
5
],
[
"Lost",
2
]
],
"fields": {
"state": {
"kind": "string"
}
},
"meta": {
"name": "Pie chart",
"description": "",
"kind": "pie",
"module": 62511111111111110,
"x": 62522222222222220,
"y": 62533333333333336,
"count": 62566666666666664
}
}