Data Exporter

Get data export

get/data-exporter/{id}

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/data-exporter/{id}
  • Auth: none declared

Path parameters

idstring required

Response

idstring required

Id of the export

statusstring required

Status of the export

creator_idstring required

Creator ID

user_idsstring[]

User IDs

conversation_idsstring[]

Conversation IDs

workspace_idstring required

Workspace ID

download_urlstring required

Signed URL of the export data

created_atstring date-time required

Created at

last_updated_atstring date-time required

Last updated at

expires_atstring date-time

Expired at

start_datestring date-time

Filter for start date

end_datestring date-time

Filter for end date

export_errorsstring[]

List of errors that occurred during processing

batch_idstring

Batch ID (Used when exporting multiple users that have multiple channels)

Example response

{
  "id": "66666666",
  "status": "success",
  "creator_id": "1111123",
  "user_ids": [
    "1111123",
    "1111124"
  ],
  "conversation_ids": [
    "1111123",
    "1111124"
  ],
  "workspace_id": "11xx1231",
  "download_url": "https://s3.us-east-1.amazonaws.com/example.com/export/66666666",
  "created_at": "2024-01-01T00:00:00.000Z",
  "last_updated_at": "2024-01-01T00:00:00.000Z",
  "expires_at": "2024-01-01T00:00:00.000Z",
  "start_date": "2024-01-01T00:00:00.000Z",
  "end_date": "2024-01-01T00:00:00.000Z",
  "completion_percentage": {
    "users": 100,
    "conversations": 15,
    "messages": 90
  },
  "completion_status": {
    "users": true,
    "conversations": true,
    "messages": true
  },
  "total_records_to_export": {
    "users": 100,
    "conversations": 15,
    "messages": 90
  },
  "export_errors": [
    "Error 1",
    "Error 2"
  ],
  "batch_id": "1111123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.