Export Conversations (POST)

POST

https://api.devrev.ai/conversations.export

POST

/conversations.export

1 curl -X POST https://api.devrev.ai/conversations.export \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

1 {
2   "conversations": [
3     {
4       "id": "foo",
5       "members": [
6         {
7           "display_id": "foo",
8           "id": "foo",
9           "display_name": "foo",
10           "display_picture": {
11             "display_id": "foo",
12             "id": "foo",
13             "file": {
14               "type": "foo",
15               "name": "foo",
16               "size": 42
17             }
18           },
19           "email": "foo",
20           "full_name": "foo",
21           "state": "active"
22         }
23       ],
24       "actual_close_date": "2023-01-01T12:00:00.000Z",
25       "channels": [
26         {
27           "id": "foo",
28           "display_id": "foo"
29         }
30       ],
31       "created_by": {
32         "display_id": "foo",
33         "id": "foo",
34         "display_name": "foo",
35         "display_picture": {
36           "display_id": "foo",
37           "id": "foo",
38           "file": {
39             "type": "foo",
40             "name": "foo",
41             "size": 42
42           }
43         },
44         "email": "foo",
45         "full_name": "foo",
46         "state": "active"
47       },
48       "created_date": "2023-01-01T12:00:00.000Z",
49       "custom_fields": {},
50       "custom_schema_fragments": [
51         "foo"
52       ],
53       "description": "foo",
54       "display_id": "foo",
55       "group": {
56         "id": "foo",
57         "display_id": "foo",
58         "member_type": "dev_user",
59         "name": "foo",
60         "sync_metadata": {
61           "external_reference": "foo",
62           "origin_system": "foo"
63         }
64       },
65       "messages": [
66         {
67           "created_by": {},
68           "created_date": "2023-01-01T12:00:00.000Z",
69           "display_id": "foo",
70           "id": "foo",
71           "modified_by": {},
72           "modified_date": "2023-01-01T12:00:00.000Z",
73           "external_ref": "foo",
74           "labels": [
75             "foo"
76           ],
77           "object": "foo",
78           "object_display_id": "foo",
79           "object_type": "account",
80           "panels": [
81             "alerts"
82           ],
83           "reactions": [
84             {
85               "emoji": "foo",
86               "reacted": true,
87               "total_users": 42
88             }
89           ],
90           "sync_metadata": {
91             "external_reference": "foo",
92             "last_sync_in": {
93               "status": "failed",
94               "sync_date": "2023-01-01T12:00:00.000Z",
95               "sync_unit": {}
96             },
97             "last_sync_out": {
98               "status": "failed",
99               "sync_date": "2023-01-01T12:00:00.000Z",
100               "sync_unit": {}
101             },
102             "origin_system": "foo"
103           },
104           "thread": {
105             "total_replies": 42
106           },
107           "visibility": "external",
108           "event": {
109             "type": "annotated",
110             "created": {
111               "object": {}
112             },
113             "deleted": {
114               "object_id": "foo"
115             },
116             "linked": {
117               "link": {
118                 "display_id": "foo",
119                 "id": "foo",
120                 "link_type": "custom_link"
121               }
122             },
123             "updated": {
124               "field_deltas": [
125                 {
126                   "name": "foo"
127                 }
128               ],
129               "object_type": "foo"
130             }
131           }
132         }
133       ],
134       "metadata": {
135         "url_context": "foo"
136       },
137       "modified_by": {
138         "display_id": "foo",
139         "id": "foo",
140         "display_name": "foo",
141         "display_picture": {
142           "display_id": "foo",
143           "id": "foo",
144           "file": {
145             "type": "foo",
146             "name": "foo",
147             "size": 42
148           }
149         },
150         "email": "foo",
151         "full_name": "foo",
152         "state": "active"
153       },
154       "modified_date": "2023-01-01T12:00:00.000Z",
155       "owned_by": [
156         {
157           "display_id": "foo",
158           "id": "foo",
159           "display_name": "foo",
160           "display_picture": {
161             "display_id": "foo",
162             "id": "foo",
163             "file": {
164               "type": "foo",
165               "name": "foo",
166               "size": 42
167             }
168           },
169           "email": "foo",
170           "full_name": "foo",
171           "state": "active"
172         }
173       ],
174       "sla_summary": {
175         "closest_to_breach_metric": "foo",
176         "org_schedule": {
177           "id": "foo",
178           "status": "archived",
179           "display_id": "foo",
180           "name": "foo",
181           "timezone": "foo",
182           "valid_until": "2023-01-01T12:00:00.000Z"
183         },
184         "remaining_time": 42,
185         "sla_tracker": {
186           "id": "foo",
187           "metric_target_summaries": [
188             {
189               "metric_definition": {
190                 "id": "foo",
191                 "display_id": "foo",
192                 "name": "foo"
193               },
194               "stage": "foo",
195               "breached_at": "2023-01-01T12:00:00.000Z",
196               "completed_at": "2023-01-01T12:00:00.000Z",
197               "completed_in": 42,
198               "in_policy": true,
199               "is_out_of_schedule": true,
200               "next_schedule_transition": "2023-01-01T12:00:00.000Z",
201               "org_schedule": {
202                 "id": "foo",
203                 "status": "archived",
204                 "display_id": "foo",
205                 "name": "foo",
206                 "timezone": "foo",
207                 "valid_until": "2023-01-01T12:00:00.000Z"
208               },
209               "remaining_time": 42,
210               "status": "foo",
211               "target_time": "2023-01-01T12:00:00.000Z",
212               "warning_target_time": "2023-01-01T12:00:00.000Z"
213             }
214           ],
215           "applies_to_id": "foo",
216           "applies_to_type": "conversation",
217           "created_by": {
218             "display_id": "foo",
219             "id": "foo",
220             "display_name": "foo",
221             "display_picture": {},
222             "email": "foo",
223             "full_name": "foo",
224             "state": "active"
225           },
226           "created_date": "2023-01-01T12:00:00.000Z",
227           "display_id": "foo",
228           "modified_by": {
229             "display_id": "foo",
230             "id": "foo",
231             "display_name": "foo",
232             "display_picture": {},
233             "email": "foo",
234             "full_name": "foo",
235             "state": "active"
236           },
237           "modified_date": "2023-01-01T12:00:00.000Z",
238           "removed_sla_metric_history": [
239             {
240               "metric_definition": {
241                 "id": "foo",
242                 "display_id": "foo",
243                 "name": "foo"
244               },
245               "removed_at": "2023-01-01T12:00:00.000Z",
246               "removed_by": {}
247             }
248           ],
249           "sla": {
250             "id": "foo",
251             "name": "foo",
252             "status": "archived",
253             "display_id": "foo",
254             "sla_type": "external"
255           },
256           "sla_policy_id": "foo",
257           "stage": "foo",
258           "status": "foo"
259         },
260         "stage": "breached",
261         "target_time": "2023-01-01T12:00:00.000Z"
262       },
263       "sla_tracker": {
264         "id": "foo",
265         "applies_to_type": "conversation",
266         "display_id": "foo"
267       },
268       "source_channel": "foo",
269       "source_channel_v2": {
270         "id": "foo",
271         "display_id": "foo"
272       },
273       "stage": {
274         "name": "foo",
275         "notes": "foo",
276         "ordinal": 42,
277         "stage": {
278           "id": "foo",
279           "display_id": "foo",
280           "name": "foo"
281         },
282         "state": {
283           "id": "foo",
284           "display_id": "foo",
285           "is_final": true,
286           "name": "foo"
287         }
288       },
289       "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
290       "subtype": "foo",
291       "sync_metadata": {
292         "external_reference": "foo",
293         "last_sync_in": {
294           "status": "failed",
295           "sync_date": "2023-01-01T12:00:00.000Z",
296           "sync_unit": {
297             "id": "foo",
298             "display_id": "foo",
299             "external_system_type": "adaas",
300             "is_archived": true,
301             "name": "foo",
302             "sync_run": {
303               "mode": "initial",
304               "progress": {
305                 "state": "completed"
306               }
307             },
308             "sync_type": "manual"
309           }
310         },
311         "last_sync_out": {
312           "status": "failed",
313           "sync_date": "2023-01-01T12:00:00.000Z",
314           "sync_unit": {
315             "id": "foo",
316             "display_id": "foo",
317             "external_system_type": "adaas",
318             "is_archived": true,
319             "name": "foo",
320             "sync_run": {
321               "mode": "initial",
322               "progress": {
323                 "state": "completed"
324               }
325             },
326             "sync_type": "manual"
327           }
328         },
329         "origin_system": "foo"
330       },
331       "tags": [
332         {
333           "tag": {
334             "id": "foo",
335             "name": "foo",
336             "display_id": "foo",
337             "style_new": {
338               "color": "foo"
339             }
340           },
341           "value": "foo"
342         }
343       ],
344       "title": "foo"
345     }
346   ]
347 }

Exports a collection of conversation items.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

actual_close_dateobjectOptional

Provides ways to specify date ranges on objects.

applies_to_partslist of stringsOptional

Filters for conversations belonging to any of the provided parts.

brandlist of stringsOptional

Filters for tickets that are associated with any of the brands.

channelslist of stringsOptional

Filters for conversations that are associated with any of the channels.

custom_fieldsobjectOptional

Filters for custom fields.

firstintegerOptional

The number of conversation items to return. The default is '50', the maximum is '5000'.

grouplist of stringsOptional

Filters for conversation that belong to the given groups.

is_creator_verifiedbooleanOptional

Filters for conversations that are created by verified users.

is_frozenbooleanOptional

Filters for conversations that are frozen.

is_spambooleanOptional

Filters for conversations that are spam.

memberslist of stringsOptional

Filters for conversations where these users are participants.

modified_dateobjectOptional

owned_bylist of stringsOptional

Filters for conversations owned by any of these users.

rev_orgslist of stringsOptional

Filters for conversations that are associated with any of the provided Rev organizations.

sla_summaryobjectOptional

The filter for SLA summary.

source_channellist of stringsOptional

Filters for conversations with any of the provided source channels.

source_channel_v2list of stringsOptional

Filters for conversations that are associated with the source channel.

stageobjectOptional

The filter for stages.

statelist of stringsOptional

Filters for conversations with any of the provided states.

subtypelist of stringsOptional

Filters for conversation with any of the provided subtypes.

tags_v2list of objectsOptional

Filters for conversations with any of the provided tags with value.

rev_orglist of stringsOptionalDeprecated

Filters for conversations that are associated with any of the provided Rev organizations.

source_channelslist of stringsOptionalDeprecated

Filters for conversations with any of the provided source channels.

tagslist of stringsOptionalDeprecated

Filters for conversations with any of the provided tags.

Response

Success.

conversationslist of objects

The resulting collection of conversation items.

Headers

Request

Response

Errors