Data Exporter

Start data export for set of users

post/data-exporter/users

Request

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

Request body

workspace_idstring required

Workspace ID

user_idsstring[] required

Array of user IDs

start_datestring date-time

Start Date range

end_datestring date-time

End Date range

Example request

{
  "start_date": "2024-01-01T04:25:00.000Z",
  "end_date": "2024-01-10T04:25:00.000Z"
}

Response

total_batchesnumber required

Total Batches

total_usersnumber required

Total Users

total_channelsnumber required

Total Channels

total_messagesnumber required

Total Messages

batch_idstring

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

Example response

{
  "batch_exports": [
    {
      "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"
    }
  ],
  "batch_id": "1111123"
}

Changes

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