Conversations
Export Conversations
Exports a collection of conversation items.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
applies_to_parts?array<string>
Filters for conversations belonging to any of the provided parts.
brand?array<string>
Filters for tickets that are associated with any of the brands.
channels?array<string>
Filters for conversations that are associated with any of the channels.
custom_fields?object
Filters for custom fields.
Empty Object
first?integer
The number of conversation items to return. The default is '50', the maximum is '5000'.
Format
int32group?array<string>
Filters for conversation that belong to the given groups.
is_creator_verified?boolean
Filters for conversations that are created by verified users.
is_frozen?boolean
Filters for conversations that are frozen.
is_spam?boolean
Filters for conversations that are spam.
members?array<string>
Filters for conversations where these users are participants.
modified_date.after?string
Filters for objects created after the provided timestamp (inclusive).
Format
date-timemodified_date.before?string
Filters for objects created before the provided timestamp (inclusive).
Format
date-timeowned_by?array<string>
Filters for conversations owned by any of these users.
rev_org?array<string>Deprecated
Filters for conversations that are associated with any of the provided Rev organizations.
rev_orgs?array<string>
Filters for conversations that are associated with any of the provided Rev organizations.
sla_summary.stage?array<sla-summary-stage>
Filters for records with any of the provided SLA stages.
source_channel?array<string>
Filters for conversations with any of the provided source channels.
source_channel_v2?array<string>
Filters for conversations that are associated with the source channel.
source_channels?array<string>Deprecated
Filters for conversations with any of the provided source channels.
stage.name?array<string>
Filters for records in the provided stage(s) by name.
state?array<string>
Filters for conversations with any of the provided states.
subtype?array<string>
Filters for conversation with any of the provided subtypes.
tags?array<string>Deprecated
Filters for conversations with any of the provided tags.
tags_v2.id?string
The ID of the tag.
Format
idtags_v2.value?string
The value for the object's association with the tag. If specified, the value must be one that's specified in the tag's allowed values.
Format
textResponse Body
curl -X GET "https://api.devrev.ai/conversations.export?applies_to_parts=PROD-12345&brand=string&channels=string&custom_fields=&first=0&group=string&is_creator_verified=true&is_frozen=true&is_spam=true&members=DEVU-12345&modified_date.after=2023-01-01T12%3A00%3A00.000Z&modified_date.before=2023-01-01T12%3A00%3A00.000Z&owned_by=DEVU-12345&rev_org=REV-AbCdEfGh&rev_orgs=REV-AbCdEfGh&sla_summary.stage=breached&source_channel=string&source_channel_v2=string&source_channels=string&stage.name=string&state=string&subtype=string&tags=TAG-12345&tags_v2.id=TAG-12345&tags_v2.value=string"{
"conversations": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"actual_close_date": "2023-01-01T12:00:00.000Z",
"channels": [
{
"display_id": "string",
"id": "string"
}
],
"custom_fields": {},
"custom_schema_fragments": [
"don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
],
"description": "string",
"group": {
"display_id": "string",
"id": "string",
"member_type": "dev_user",
"name": "string",
"sync_metadata": {
"external_reference": "string",
"origin_system": "string"
}
},
"members": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"messages": [
{
"type": "timeline_change_event",
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"external_ref": "string",
"labels": [
"string"
],
"object": "string",
"object_display_id": "string",
"object_type": "account",
"panels": [
"alerts"
],
"reactions": [
{
"emoji": "string",
"reacted": true,
"total_users": 0
}
],
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"thread": {
"total_replies": 0
},
"visibility": "external",
"event": {
"type": "annotated",
"created": {
"object": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
}
},
"deleted": {
"object_id": "string"
},
"linked": {
"link": {
"display_id": "string",
"id": "string",
"link_type": "custom_link",
"source": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
},
"target": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
}
}
},
"updated": {
"field_deltas": [
{
"field_descriptor": {
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_required": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{}
]
}
],
"create_view": {
"is_hidden": true
},
"decimal_places": 0,
"detail_view": {
"is_hidden": true
},
"display_name": "string",
"filter_view": {
"is_hidden": true
},
"group_name": "string",
"is_active_in_detail_view": true,
"is_bulk_action_enabled": true,
"is_currency_field": true,
"is_groupable": true,
"is_hidden": true,
"is_hidden_during_create": true,
"is_read_only": true,
"is_required": true,
"is_shown_in_summary": true,
"is_sortable": true,
"list_view": {
"is_hidden": true
},
"order": 0,
"placeholder": "string",
"summary_view": {
"is_hidden": true
},
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
},
"name": "string",
"new_value": {
"type": "bool",
"value": true
},
"old_value": {
"type": "bool",
"value": true
}
}
],
"object_type": "string"
}
}
}
],
"metadata": {
"url_context": "string"
},
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"sla_summary": {
"closest_to_breach_metric": "string",
"org_schedule": {
"display_id": "string",
"id": "string",
"name": "string",
"status": "archived",
"timezone": "string",
"valid_until": "2023-01-01T12:00:00.000Z"
},
"remaining_time": 0,
"sla_tracker": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"applies_to_id": "string",
"applies_to_type": "conversation",
"metric_target_summaries": [
{
"breached_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:00:00.000Z",
"completed_in": 0,
"in_policy": true,
"is_out_of_schedule": true,
"metric_definition": {
"display_id": "string",
"id": "string",
"name": "string"
},
"next_schedule_transition": "2023-01-01T12:00:00.000Z",
"org_schedule": {
"display_id": "string",
"id": "string",
"name": "string",
"status": "archived",
"timezone": "string",
"valid_until": "2023-01-01T12:00:00.000Z"
},
"remaining_time": 0,
"stage": "string",
"status": "string",
"target_time": "2023-01-01T12:00:00.000Z",
"warning_target_time": "2023-01-01T12:00:00.000Z"
}
],
"removed_sla_metric_history": [
{
"metric_definition": {
"display_id": "string",
"id": "string",
"name": "string"
},
"removed_at": "2023-01-01T12:00:00.000Z",
"removed_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
}
],
"sla": {
"display_id": "string",
"id": "string",
"name": "string",
"sla_type": "external",
"status": "archived"
},
"sla_policy_id": "string",
"stage": "string",
"status": "string"
},
"stage": "breached",
"target_time": "2023-01-01T12:00:00.000Z"
},
"sla_tracker": {
"display_id": "string",
"id": "string",
"applies_to_type": "conversation"
},
"source_channel": "string",
"source_channel_v2": {
"display_id": "string",
"id": "string"
},
"stage": {
"name": "string",
"notes": "string",
"ordinal": 0,
"stage": {
"display_id": "string",
"id": "string",
"name": "string"
},
"state": {
"display_id": "string",
"id": "string",
"is_final": true,
"name": "string"
}
},
"stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
"subtype": "string",
"sync_metadata": {
"external_reference": "string",
"last_sync_in": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"last_sync_out": {
"status": "failed",
"sync_date": "2023-01-01T12:00:00.000Z",
"sync_unit": {
"display_id": "string",
"id": "string",
"external_system_type": "adaas",
"is_archived": true,
"name": "string",
"sync_run": {
"mode": "initial",
"progress": {
"state": "completed"
}
},
"sync_type": "manual"
}
},
"origin_system": "string"
},
"tags": [
{
"tag": {
"display_id": "string",
"id": "string",
"name": "string",
"style_new": {
"color": "string"
}
},
"value": "string"
}
],
"title": "string"
}
]
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}