Recipe File Resource

The recipe's file content.

Resource URL

1/wave/recipes/<id>/file

Formats

JSON

Available Version

38.0

HTTP Methods

GET

GET Response Body

StreamedRepresentation. Returns a binary stream of the contents of the specified file.

The following is an example JSON representation resulting from the GET method.

1{
2  "version":"210.0.0",
3  "tableModelInfo":{
4    "fieldAttributes":{
5
6    },
7    "rootDataset":{
8      "fetcherType":"EdgemartFetcher",
9      "qualifier":"RawEngagementHistory",
10      "label":"RawEngagementHistory",
11      "fields":[
12        {
13          "name":"WhatId",
14          "label":"What ID"
15        },
16        {
17          "name":"WhoId",
18          "label":"Who ID"
19        },
20        {
21          "name":"ActivityDate",
22          "label":"Activity Date"
23        },
24        {
25          "name":"ProspectName"
26        },
27        {
28          "name":"Form.CampaignId.Name"
29        },
30        {
31          "name":"ActivityType",
32          "label":"Activity Type"
33        },
34        {
35          "name":"CreatedDate",
36          "label":"Created Date"
37        },
38        {
39          "name":"Lead.Name"
40        },
41        {
42          "name":"Form.CampaignId"
43        },
44        {
45          "name":"Form.Name"
46        },
47        {
48          "name":"Contact.Name"
49        },
50        {
51          "name":"Id",
52          "label":"Engagement History ID"
53        }
54      ],
55      "name":"0FbB0000000Csample",
56      "devName":"RawEngagementHistory",
57      "namespace":null
58    }
59  },
60  "sampleInfo":{
61    "targetRowSampleSize":5000
62  },
63  "publishFields":[
64    {
65      "name":"RawEngagementHistory$WhatId",
66      "label":"What ID"
67    },
68    {
69      "name":"calcs$WhatId_substring_textBucket",
70      "label":"What ID substring textBucket"
71    },
72    {
73      "name":"RawEngagementHistory$WhoId",
74      "label":"Who ID"
75    },
76    {
77      "name":"calcs$WhoId_substring_textBucket",
78      "label":"Who ID substring textBucket"
79    },
80    {
81      "name":"RawEngagementHistory$ActivityDate",
82      "label":"Activity Date"
83    },
84    {
85      "name":"RawEngagementHistory$ProspectName"
86    },
87    {
88      "name":"RawEngagementHistory$Form.CampaignId.Name"
89    },
90    {
91      "name":"RawEngagementHistory$ActivityType",
92      "label":"Activity Type"
93    },
94    {
95      "name":"RawEngagementHistory$Lead.Name"
96    },
97    {
98      "name":"RawEngagementHistory$Form.CampaignId"
99    },
100    {
101      "name":"RawEngagementHistory$Form.Name"
102    },
103    {
104      "name":"RawEngagementHistory$Contact.Name"
105    }
106  ],
107  "steps":[
108    {
109      "type":"SUBSTRING_FIELD",
110      "lastEdit":{
111        "userName":"Donald Go",
112        "timeInMs":null
113      },
114      "sourceField":{
115        "name":"RawEngagementHistory$WhatId",
116        "label":"What ID"
117      },
118      "targetName":"WhatId_substring",
119      "targetTableQualifier":"calcs",
120      "start":1,
121      "length":3
122    },
123    {
124      "type":"SUBSTRING_FIELD",
125      "lastEdit":{
126        "userName":"Donald Go",
127        "timeInMs":null
128      },
129      "sourceField":{
130        "name":"RawEngagementHistory$WhoId",
131        "label":"Who ID"
132      },
133      "targetName":"WhoId_substring",
134      "targetTableQualifier":"calcs",
135      "start":1,
136      "length":3
137    },
138    {
139      "type":"TEXT_CASE_STATEMENT_FIELD",
140      "lastEdit":{
141        "userName":"Donald Go",
142        "timeInMs":null
143      },
144      "sourceField":{
145        "name":"calcs$WhatId_substring",
146        "label":"What ID substring"
147      },
148      "targetName":"WhatId_substring_textBucket",
149      "targetTableQualifier":"calcs",
150      "categoryMappings":{
151        "showUnmappedValuesAsOther":false,
152        "unmappedBucket":"Other",
153        "categoryMappings":{
154          "1Mx":"Form"
155        }
156      }
157    },
158    {
159      "type":"TEXT_CASE_STATEMENT_FIELD",
160      "lastEdit":{
161        "userName":"Donald Go",
162        "timeInMs":null
163      },
164      "sourceField":{
165        "name":"calcs$WhoId_substring",
166        "label":"Who ID substring"
167      },
168      "targetName":"WhoId_substring_textBucket",
169      "targetTableQualifier":"calcs",
170      "categoryMappings":{
171        "showUnmappedValuesAsOther":false,
172        "unmappedBucket":"Other",
173        "categoryMappings":{
174          "00Q":"Lead",
175          "003":"Contact"
176        }
177      }
178    }
179  ],
180  "datasetLabel":"API Test Engagement History"
181}

Analytics REST API Developer Guide

Recipe File Resource