Edit in GitHubLog an issue

Project Definition Data Structure

The project definition data structure is used to communicate project rules to the API. This data structure defines the raw logic that is used to layout a workspace project. The project definition is a hierarchical data structure of workspaces, panels, and other properties that are used to define the project. Workspace in the CJA UI defines these rules and can be a useful tool for creating and understanding how projects are structured.

Example#

The following example is a very simple report to show all visits noted under a specific report suite for the last month. As you can see, even though it's a very simple report, the definition is very large. It is suggested that creating Workspace Projects be done in the CJA UI, and the /projects endpoints be used to update or copy projects in simple ways.

If creating a project through the API is required, make sure to utilize the /projects/validate endpoint, as described in the Projects Guide.

Copied to your clipboard
1{
2 "definition": {
3 "additionalCuratedComponents": [],
4 "colorScheme": {
5 "id": "default",
6 "label": "",
7 "value": [
8 "#00C0C7",
9 "#5144D3",
10 "#E8871A",
11 "#DA3490",
12 "#9089FA",
13 "#47E26F",
14 "#2780EB",
15 "#6F38B1",
16 "#DFBF03",
17 "#CB6F10",
18 "#268D6C",
19 "#9BEC54",
20 "#5EABFA",
21 "#BE40CC",
22 "#F56BB7",
23 "#FEE02D"
24 ]
25 },
26 "countRepeatInstances": true,
27 "currentWorkspaceIndex": 0,
28 "customColorSchemes": [],
29 "isCurated": false,
30 "version": "31",
31 "viewDensity": "expanded",
32 "workspaces": [
33 {
34 "id": "3B1FE317-C72A-4983-ABF1-D3BD14A8D511",
35 "name": "",
36 "panels": [
37 {
38 "annotations": [],
39 "collapsed": false,
40 "dateRange": {
41 "id": "thisMonth",
42 "__entity__": true,
43 "type": "DateRange",
44 "__metaData__": {
45 "name": "This month"
46 }
47 },
48 "description": "",
49 "id": "C0DACAE8-CCE1-4332-9496-ABDBE80C9C23",
50 "name": "Freeform",
51 "position": {
52 "autoHeight": 374,
53 "autoSize": true,
54 "width": 100,
55 "x": 0,
56 "y": 0
57 },
58 "reportSuite": {
59 "id": "dv_000000000000000000",
60 "__entity__": true,
61 "type": "ReportSuite",
62 "__metaData__": {
63 "name": "dv name",
64 "rsid": "dv_000000000000000000"
65 }
66 },
67 "segmentGroups": [],
68 "subPanels": [
69 {
70 "collapsed": false,
71 "description": "",
72 "id": "F2AAAA88-E63E-4AB6-9090-3612F378B9F0",
73 "isQuickInsightsSubPanel": false,
74 "linkedSourceId": "",
75 "position": {
76 "autoHeight": 222,
77 "autoSize": true,
78 "width": 100,
79 "x": 0,
80 "y": 0
81 },
82 "reportlet": {
83 "advancedMode": false,
84 "advancedSettings": {
85 "rows": [],
86 "tableState": "builder"
87 },
88 "columnTree": {
89 "_computedValues": [],
90 "dataSettings": {
91 "advancedItemLimit": 5,
92 "advancedItemSearch": {
93 "operator": "AND",
94 "rules": []
95 }
96 },
97 "id": "f46df4-2",
98 "name": "",
99 "nodes": [
100 {
101 "_computedValues": [],
102 "component": {
103 "id": "All_Visits",
104 "__entity__": true,
105 "type": "Segment",
106 "__metaData__": {
107 "name": "All Visits"
108 }
109 },
110 "dataSettings": {
111 "advancedItemLimit": 5,
112 "advancedItemSearch": {
113 "operator": "AND",
114 "rules": []
115 }
116 },
117 "id": "f46df4-4",
118 "name": "All Visits",
119 "nodes": [],
120 "selectionCoordinates": [],
121 "tableCellDisplay": {
122 "conditionalFormattingOpts": {
123 "autoGenerate": true,
124 "usePercentLimits": false
125 },
126 "location": "behindNumber",
127 "type": {
128 "anomaly": true,
129 "background": true,
130 "backgroundType": "bar",
131 "comparison": "none",
132 "interpretZeroAsNoValue": false,
133 "number": true,
134 "percent": true,
135 "showGrandTotal": true,
136 "showSparklines": true,
137 "showTotals": true,
138 "wrapHeaderText": true
139 }
140 }
141 }
142 ],
143 "selectionCoordinates": [],
144 "tableCellDisplay": {
145 "conditionalFormattingOpts": {
146 "autoGenerate": true,
147 "usePercentLimits": false
148 },
149 "location": "behindNumber",
150 "type": {
151 "anomaly": true,
152 "background": true,
153 "backgroundType": "bar",
154 "comparison": "none",
155 "interpretZeroAsNoValue": false,
156 "number": true,
157 "percent": true,
158 "showGrandTotal": true,
159 "showSparklines": true,
160 "showTotals": true,
161 "wrapHeaderText": true
162 }
163 }
164 },
165 "freeformTable": {
166 "alignDatesForTimeDimension": true,
167 "attributionSettings": [],
168 "breakdowns": [],
169 "collapsed": false,
170 "columnWidths": [
171 100,
172 100
173 ],
174 "pagination": {
175 "currentPage": 0,
176 "viewBy": 50
177 },
178 "search": {
179 "operator": "AND",
180 "rules": []
181 },
182 "selectionCoordinates": [],
183 "settings": {
184 "breakdownByPosition": false,
185 "rowBasedPercentages": false,
186 "totalsType": "columnSum"
187 },
188 "sort": {
189 "asc": false,
190 "columnId": "f46df4-4",
191 "labelColumn": false
192 },
193 "staticRows": [
194 {
195 "component": {
196 "id": "metrics/visits",
197 "__entity__": true,
198 "type": "Metric",
199 "__metaData__": {
200 "name": "Visits"
201 }
202 },
203 "dataSettings": {
204 "advancedItemLimit": 5,
205 "advancedItemSearch": {
206 "operator": "AND",
207 "rules": []
208 }
209 },
210 "id": "f46df4-a"
211 }
212 ],
213 "statistics": {
214 "functions": [],
215 "ignoreZeros": true
216 }
217 },
218 "isConfigVisible": true,
219 "type": "FreeformReportlet"
220 },
221 "swatchColor": "#00C0C7",
222 "type": "genericSubPanel",
223 "visible": true,
224 "visualizationIndex": 1
225 }
226 ],
227 "type": "panel"
228 }
229 ]
230 }
231 ]
232 }
233}
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.