POST /api/v2/query

Use the POST endpoint of Query API V2 to make the first request with the SQL query. The POST endpoint returns data along with batchId for the next batch.

Syntax

HTTP method: POST
Availability: Data Cloud v2.0, Salesforce 54.0
Formats: REST
URI: /api/v2/query

Examples

Request Header

1Authorization: Bearer {{cdpAuthToken}}

Request

1{
2    "sql" : "select * from Orders__dll"
3}

Response

The placeInOrder parameter indicates the position of the column in each data row. For example, in the following response InternalOrganization__c is the second column in a data row. Similarly quantity__c is the third column. For information on the typeCodes, refer to SQL data type codes.

Note

1{
2    "data": [
3        [
4            "s3://dev1-uswest2-cdp001-test-data/sbothra/Orders.csv",
5            "aws",
6            null,
7            null,
8            "Office Supplies",
9            "0019-01-03",
10            null,
11            "Philadelphia",
12            "United States",
13            "MB-18085",
14            "Mick Brown",
15            "0.200000000000000000",
16            "570907236",
17            "0019-01-05 00:00:00.000 UTC",
18            "0019-01-05",
19            "CA-NEW-2014-141817",
20            "19143.000000000000000000",
21            "OFF-AR-10003478",
22            "Avery Hi-Liter EverBold Pen Style Fluorescent Highlighters 4/Pack",
23            "4.884000000000000000",
24            "3.000000000000000000",
25            "East",
26            "1760",
27            "19.536000000000000000",
28            "Consumer",
29            "0019-01-12 00:00:00.000 UTC",
30            "0019-01-12",
31            "Standard Class",
32            "Pennsylvania",
33            "Art"
34        ],
35        [
36            "s3://dev1-uswest2-cdp001-test-data/sbothra/Orders.csv",
37            "aws",
38            null,
39            null,
40            "Furniture",
41            "0021-01-06",
42            null,
43            "Seattle",
44            "United States",
45            "RS-19420",
46            "Ricardo Sperren",
47            "0.000000000000000000",
48            "307077322",
49            "0021-01-08 00:00:00.000 UTC",
50            "0021-01-08",
51            "CA-NEW-2017-115154",
52            "98115.000000000000000000",
53            "FUR-TA-10001950",
54            "Balt Solid Wood Round Tables",
55            "80.368200000000000000",
56            "2.000000000000000000",
57            "West",
58            "2290",
59            "892.980000000000000000",
60            "Corporate",
61            "0021-01-11 00:00:00.000 UTC",
62            "0021-01-11",
63            "First Class",
64            "Washington",
65            "Tables"
66        ]
67    ],
68    "startTime": "2024-05-08T13:30:31.241168Z",
69    "endTime": "2024-05-08T13:30:35.571609Z",
70    "rowCount": 2,
71    "queryId": "20240508_133031_00088_p25a7",
72    "nextBatchId": "09151b49-54ed-4948-8139-1f4c7c3a9581",
73    "done": false,
74    "metadata": {
75        "state__c": {
76            "type": "VARCHAR",
77            "placeInOrder": 28,
78            "typeCode": 12
79        },
80        "sales__c": {
81            "type": "DECIMAL",
82            "placeInOrder": 23,
83            "typeCode": 3
84        },
85        "productid__c": {
86            "type": "VARCHAR",
87            "placeInOrder": 17,
88            "typeCode": 12
89        },
90        "segment__c": {
91            "type": "VARCHAR",
92            "placeInOrder": 24,
93            "typeCode": 12
94        },
95        "individualid__c": {
96            "type": "VARCHAR",
97            "placeInOrder": 12,
98            "typeCode": 12
99        },
100        "shipdate1__c": {
101            "type": "TIMESTAMP WITH TIME ZONE",
102            "placeInOrder": 25,
103            "typeCode": 2014
104        },
105        "shipmode__c": {
106            "type": "VARCHAR",
107            "placeInOrder": 27,
108            "typeCode": 12
109        },
110        "rowid__c": {
111            "type": "VARCHAR",
112            "placeInOrder": 22,
113            "typeCode": 12
114        },
115        "InternalOrganization__c": {
116            "type": "VARCHAR",
117            "placeInOrder": 2,
118            "typeCode": 12
119        },
120        "orderdate1__c": {
121            "type": "TIMESTAMP WITH TIME ZONE",
122            "placeInOrder": 13,
123            "typeCode": 2014
124        },
125        "customername__c": {
126            "type": "VARCHAR",
127            "placeInOrder": 10,
128            "typeCode": 12
129        },
130        "quantity__c": {
131            "type": "DECIMAL",
132            "placeInOrder": 20,
133            "typeCode": 3
134        },
135        "DataSource__c": {
136            "type": "VARCHAR",
137            "placeInOrder": 1,
138            "typeCode": 12
139        },
140        "orderdate__c": {
141            "type": "DATE",
142            "placeInOrder": 14,
143            "typeCode": 91
144        },
145        "cdp_sys_PartitionDate__c": {
146            "type": "DATE",
147            "placeInOrder": 5,
148            "typeCode": 91
149        },
150        "orderid__c": {
151            "type": "VARCHAR",
152            "placeInOrder": 15,
153            "typeCode": 12
154        },
155        "region__c": {
156            "type": "VARCHAR",
157            "placeInOrder": 21,
158            "typeCode": 12
159        },
160        "KQ_orderid__c": {
161            "type": "VARCHAR",
162            "placeInOrder": 3,
163            "typeCode": 12
164        },
165        "discount__c": {
166            "type": "DECIMAL",
167            "placeInOrder": 11,
168            "typeCode": 3
169        },
170        "postalcode__c": {
171            "type": "DECIMAL",
172            "placeInOrder": 16,
173            "typeCode": 3
174        },
175        "city__c": {
176            "type": "VARCHAR",
177            "placeInOrder": 7,
178            "typeCode": 12
179        },
180        "profit__c": {
181            "type": "DECIMAL",
182            "placeInOrder": 19,
183            "typeCode": 3
184        },
185        "customerid__c": {
186            "type": "VARCHAR",
187            "placeInOrder": 9,
188            "typeCode": 12
189        },
190        "category__c": {
191            "type": "VARCHAR",
192            "placeInOrder": 4,
193            "typeCode": 12
194        },
195        "sub_category__c": {
196            "type": "VARCHAR",
197            "placeInOrder": 29,
198            "typeCode": 12
199        },
200        "cdp_sys_SourceVersion__c": {
201            "type": "VARCHAR",
202            "placeInOrder": 6,
203            "typeCode": 12
204        },
205        "country__c": {
206            "type": "VARCHAR",
207            "placeInOrder": 8,
208            "typeCode": 12
209        },
210        "shipdate__c": {
211            "type": "DATE",
212            "placeInOrder": 26,
213            "typeCode": 91
214        },
215        "productname__c": {
216            "type": "VARCHAR",
217            "placeInOrder": 18,
218            "typeCode": 12
219        },
220        "DataSourceObject__c": {
221            "type": "VARCHAR",
222            "placeInOrder": 0,
223            "typeCode": 12
224        }
225    }
226}

HTTP Responses

Query Services Status Codes

Data Cloud Reference Guide

POST /api/v2/query

Syntax

Examples

HTTP Responses