Listing

GET/api/v1/cx-logs

As the name suggests, cx logs are a core part of klink.cloud — the very reason klink.cloud exists is so you can have check daily call logs conversations with your cx logs. On this page, we'll dive into the different cx logs endpoints you can use to manage cx logs programmatically. We'll look at how to query, create, update, and delete tags.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params

selectedDatestringrequired
The selectedDate for the cx logs (example. 2025/04/01 00:00:00-2025/04/25 23:59:00).

Example:2026/04/01 00:00:00-2026/04/30 23:59:59
pagenumberoptional
Page number of cx logs.

Example:1
pageSizenumberoptional
Page size that is showing the data amout of cx logs.

Example:20
direction[]array[string]optional
Direction of the cxlog chatroom when first created.

Example:["outbound"]
channelIds[]array[string]optional
A list of ID of channel

Example:["4da39031-79b0-4fec-9800-4d9199ec82d5"]
contactChannel[]array[string]optional
Filter by Channel type such as line, whatsapp,mail, etc

Example:["mail"]
closedAtstringoptional
Filter by closed at for th cx logs ( 2026/04/01 00:00:00-2026/04/01 23:59:59)

Example:2026/04/01 00:00:00-2026/04/02 23:59:59
roomStatuses[]stringoptional
filter by current chat room status

Example:unassigned, active, hold, closed
queueIds[]stringoptional
Example:ID of queue

Header Params

x-client-timezonestringrequired
The time zone base on country. (example. x-client-timezone : Asia/Bangkok).

Example:Asia/Singapore

Responses

200

requestIdstringrequired
cxLogsobjectrequired
Child attributes
- dataarray[object]required
  Child attributes
  idstring | nulloptional
  caseIdinteger | nulloptional
  entityIdstring | nulloptional
  entityNamestring | nulloptional
  contactIdstring | nulloptional
  channelstring | nulloptional
  queueIdstring | nulloptional
  agentIdstring | nulloptional
  directionstring | nulloptional
  startedDatestring | nulloptional
  closedAtstring | nulloptional
  handledTimeinteger | nulloptional
  totalHoldDurationinteger | nulloptional
  firstResponseTimeinteger | nulloptional
  dispositionstring | nulloptional
  channelTypestring | nulloptional
  customerPhonestring | nulloptional
  contactLabelarray[string] | nulloptional
  queueNamestring | nulloptional
  uidstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  wrapUpFormIdstring | nulloptional
  wrapUpDurationinteger | nulloptional
  slaStatusstring | nulloptional
  firstAssigneeIdstring | nulloptional
  closedAssigneeIdstring | nulloptional
  fullHandledTimeinteger | nulloptional
  resolutionTimeinteger | nulloptional
  fullResolutionTimeinteger | nulloptional
  cxIntelligenceStatusstring | nulloptional
  firstRepliedTimeinteger | nulloptional
  contactobject | nulloptional
  Child attributes
  idstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  namestring | nulloptional
  addressstring | nulloptional
  channelstring | nulloptional
  notesstring | nulloptional
  contactNumberstring | integer | nulloptional
  companyIdstring | nulloptional
  contactProfilestring | nulloptional
  socialProfileUrlstring | nulloptional
  tagsarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  positioninteger | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  platformContactsarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  channelIdstring | nulloptional
  socialPlatformIdstring | nulloptional
  typestring | nulloptional
  botpress_user_metadataobject | array[any] | nulloptional
  firstAssigneeobject | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  emailstring | nulloptional
  addressstring | nulloptional
  phonestring | nulloptional
  notificationCountinteger | nulloptional
  deletedaAtnulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  providerstring | nulloptional
  providerIdstring | nulloptional
  firstNamestring | nulloptional
  lastNamestring | nulloptional
  agentobject | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  emailstring | nulloptional
  addressstring | nulloptional
  phonestring | nulloptional
  notificationCountinteger | nulloptional
  deletedaAtnulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  providerstring | nulloptional
  providerIdstring | nulloptional
  firstNamestring | nulloptional
  lastNamestring | nulloptional
  closedAssigneeobject | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  emailstring | nulloptional
  addressstring | nulloptional
  phonestring | nulloptional
  notificationCountinteger | nulloptional
  deletedaAtnulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  providerstring | nulloptional
  providerIdstring | nulloptional
  firstNamestring | nulloptional
  lastNamestring | nulloptional
  mailRoomobject | nulloptional
  roomobject | nulloptional
  Child attributes
  idstring | nulloptional
  channel_idstring | nulloptional
  platform_contact_idstring | nulloptional
  actor_idstring | nulloptional
  assignee_idstring | nulloptional
  last_messagestring | nulloptional
  handled_timeinteger | nulloptional
  first_response_atstring | nulloptional
  unread_countinteger | nulloptional
  closed_atstring | nulloptional
  directionstring | nulloptional
  is_latestboolean | nulloptional
  created_atstring | nulloptional
  updated_atstring | nulloptional
  statusinteger | nulloptional
  last_message_atstring | nulloptional
  actor_typestring | nulloptional
  is_bot_roomboolean | nulloptional
  csat_statusstring | nulloptional
  notesstring | nulloptional
  first_response_timeinteger | nulloptional
  automation_queue_idstring | nulloptional
  telegram_business_connection_idstring | nulloptional
  is_groupboolean | nulloptional
  first_assignee_idstring | nulloptional
  closed_assignee_idstring | nulloptional
  holding_timeinteger | nulloptional
  unhold_label_idstring | nulloptional
  first_replied_atstring | nulloptional
  first_replied_timeinteger | nulloptional
  is_ai_agent_roomboolean | nulloptional
  thread_idstring | nulloptional
  subjectstring | nulloptional
  cx_log_partition_keystring | nulloptional
  channelobject | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  typestring | nulloptional
  brand_namestring | nulloptional
  platform_idstring | nulloptional
  statusboolean | nulloptional
  created_atstring | nulloptional
  updated_atstring | nulloptional
  is_relogin_requiredboolean | nulloptional
  connected_user_namestring | nulloptional
  connected_user_idstring | nulloptional
  actor_idstring | nulloptional
  botpress_bot_idstring | nulloptional
  csat_preferencesobject | nulloptional
  Child attributes
  imagestring | nulloptional
  headlinestring | nulloptional
  dispositionsarray[string] | nulloptional
  scaleOptionsarray[object] | nulloptional
  Child attributes
  labelstring | nulloptional
  valueinteger | string | nulloptional
  last_assigned_messageobject | nulloptional
  Child attributes
  idstring | nulloptional
  partition_keystring | nulloptional
  room_idstring | nulloptional
  sender_idstring | nulloptional
  actor_idstring | nulloptional
  assignee_idstring | nulloptional
  upload_idstring | nulloptional
  messagestring | nulloptional
  directionstring | nulloptional
  typestring | nulloptional
  metadataobject | nulloptional
  platform_idstring | nulloptional
  reply_platform_message_idstring | nulloptional
  platform_message_idstring | nulloptional
  templatestring | nulloptional
  localestring | nulloptional
  urlstring | nulloptional
  read_atstring | nulloptional
  created_atstring | nulloptional
  updated_atstring | nulloptional
  deleted_atnulloptional
  preview_urlstring | nulloptional
  image_set_idstring | nulloptional
  actor_typestring | nulloptional
  parent_message_idstring | nulloptional
  reply_reactionstring | nulloptional
  feed_post_idstring | nulloptional
  link_message_idstring | nulloptional
  edited_message_idstring | nulloptional
  is_editedboolean | nulloptional
  edited_atstring | nulloptional
  labelstring | nulloptional
  contact_idstring | nulloptional
  link_message_partition_keystring | nulloptional
  edited_message_partition_keystring | nulloptional
  parent_message_partition_keystring | nulloptional
  client_request_idstring | nulloptional
  queueobject | nulloptional
  automationQueueobject | nulloptional
  wrapUpFormobject | nulloptional
  Child attributes
  idstring | nulloptional
  dispositionstring | nulloptional
  notestring | nulloptional
  deletedAtnulloptional
  callFromstring | nulloptional
  callTostring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  typestring | nulloptional
  categoriesarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  valuestring | nulloptional
  parentIdstring | nulloptional
  levelinteger | nulloptional
  tagsarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  namestring | nulloptional
  customFieldsarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  textValuestring | nulloptional
  booleanValueboolean | nulloptional
  numberValueinteger | number | nulloptional
  dateValuestring | nulloptional
  entityIdstring | nulloptional
  attributeIdstring | nulloptional
  attributeobject | nulloptional
  Child attributes
  idstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  displayNamestring | nulloptional
  systemNamestring | nulloptional
  typestring | nulloptional
  positioninteger | nulloptional
  isDefaultboolean | nulloptional
  isArchivedboolean | nulloptional
  isRequiredboolean | nulloptional
  isUniqueboolean | nulloptional
  groupIdstring | nulloptional
  evaluateFormobject | nulloptional
  holdLogsarray[object] | nulloptional
  Child attributes
  idstring | nulloptional
  started_atstring | nulloptional
  ended_atstring | nulloptional
  durationinteger | nulloptional
  hold_label_idstring | nulloptional
  cx_log_idstring | nulloptional
  created_atstring | nulloptional
  updated_atstring | nulloptional
  deleted_atnulloptional
  cx_log_partition_keystring | nulloptional
  telephonyCdrobject | nulloptional
  Child attributes
  idstring | nulloptional
  uniqueCallIdstring | nulloptional
  timeStartstring | nulloptional
  callFromstring | nulloptional
  callTostring | nulloptional
  callDurationinteger | nulloptional
  talkDurationinteger | nulloptional
  srcTrunkNamestring | nulloptional
  dstTrunkNamestring | nulloptional
  statusstring | nulloptional
  typestring | nulloptional
  recordingstring | nulloptional
  didNumberstring | nulloptional
  agentRingTimeinteger | nulloptional
  uploadIdstring | nulloptional
  serialNumberstring | nulloptional
  extensionIdstring | nulloptional
  telephonyQueueIdstring | nulloptional
  contactIdstring | nulloptional
  createdAtstring | nulloptional
  updatedAtstring | nulloptional
  deletedAtnulloptional
  isQueueMissedCallboolean | nulloptional
  callParticipantsarray[string] | nulloptional
  wrapUpFormIdstring | nulloptional
  telephonyIvrIdstring | nulloptional
  transcriptstring | nulloptional
- totalintegerrequired
- pageintegerrequired
- pageSizeintegerrequired
- lastPageintegerrequired

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/cx-logs?selectedDate=2026%2F04%2F01%2000%3A00%3A00-2026%2F04%2F30%2023%3A59%3A59" \
  -H "Authorization: Bearer {token}"

Response

{
  "requestId": "uuid-string",
  "cxLogs": {
    "data": [
      {
        "id": "uuid-string",
        "caseId": 12540,
        "entityId": "uuid-string",
        "entityName": "room",
        "contactId": "uuid-string",
        "channel": "messenger",
        "queueId": "uuid-string",
        "agentId": "uuid-string",
        "direction": "inbound",
        "startedDate": "2026-03-30 08:30:00.000+00",
        "closedAt": "2026-03-30 09:15:20+00",
        "handledTime": 2720,
        "totalHoldDuration": 45,
        "firstResponseTime": 120,
        "disposition": "Resolved",
        "channelType": "messenger",
        "customerPhone": null,
        "contactLabel": [
          "Premium Support",
          "Technical-V2"
        ],
        "queueName": "Tier 2 Technical Support",
        "uid": "PSID-1029384756",
        "createdAt": "2026-03-30T08:30:05.123Z",
        "updatedAt": "2026-03-30T09:15:25.000Z",
        "deletedAt": null,
        "wrapUpFormId": "uuid-string",
        "wrapUpDuration": 180,
        "slaStatus": "meet",
        "firstAssigneeId": "uuid-string",
        "closedAssigneeId": "uuid-string",
        "fullHandledTime": 2765,
        "resolutionTime": 2905,
        "fullResolutionTime": 2965,
        "cxIntelligenceStatus": "processed",
        "firstRepliedTime": 125,
        "contact": {
          "id": "uuid-string",
          "createdAt": "2026-01-15T10:00:00.000Z",
          "updatedAt": "2026-03-30T08:30:00.000Z",
          "deletedAt": null,
          "name": "John Doe",
          "address": "123 Business Ave, Singapore",
          "channel": "messenger",
          "notes": "Preferred contact method: Messenger",
          "contactNumber": "+6591234567",
          "companyId": "uuid-string",
          "contactProfile": "https://cdn.klink.cloud/assets/profiles/john_doe_avatar.jpg",
          "socialProfileUrl": "https://facebook.com/john.doe.sample",
          "tags": [
            {
              "id": "uuid-string",
              "name": "VIP"
            }
          ],
          "platformContacts": [
            {
              "id": "uuid-string",
              "createdAt": "2026-01-15T10:00:00.000Z",
              "updatedAt": "2026-03-30T08:30:00.000Z",
              "deletedAt": null,
              "channelId": "uuid-string",
              "socialPlatformId": "PSID-1029384756",
              "type": "messenger",
              "botpress_user_metadata": null
            }
          ]
        },
        "firstAssignee": {
          "id": "uuid-string",
          "name": "Sarah Jenkins",
          "email": "sarah.j@klink.cloud",
          "address": null,
          "phone": null,
          "notificationCount": 0,
          "deletedaAt": null,
          "createdAt": "2024-05-10T09:00:00.000Z",
          "updatedAt": "2026-03-25T14:20:00.000Z",
          "provider": "google",
          "providerId": "uuid-string",
          "firstName": "Sarah",
          "lastName": "Jenkins"
        },
        "agent": {
          "id": "uuid-string",
          "name": "Sarah Jenkins",
          "email": "sarah.j@klink.cloud",
          "phone": null
        },
        "closedAssignee": {
          "id": "uuid-string",
          "name": "Sarah Jenkins",
          "email": "sarah.j@klink.cloud"
        },
        "mailRoom": null,
        "room": {
          "id": "uuid-string",
          "channel_id": "uuid-string",
          "platform_contact_id": "uuid-string",
          "actor_id": "uuid-string",
          "assignee_id": "uuid-string",
          "last_message": "Thank you for the update, your issue has been resolved.",
          "handled_time": 2720,
          "first_response_at": "2026-03-30 08:32:00+00",
          "unread_count": 0,
          "closed_at": "2026-03-30 09:15:20+00",
          "direction": "outgoing",
          "is_latest": true,
          "created_at": "2026-03-30T08:30:00.000Z",
          "updated_at": "2026-03-30T09:15:20.000Z",
          "status": 1,
          "last_message_at": "2026-03-30 09:12:00+00",
          "actor_type": "user",
          "is_bot_room": false,
          "csat_status": "sent",
          "notes": "Issue related to account sync. Resolved by resetting session tokens.",
          "first_response_time": 120,
          "automation_queue_id": null,
          "telegram_business_connection_id": null,
          "is_group": false,
          "first_assignee_id": "uuid-string",
          "closed_assignee_id": "uuid-string",
          "holding_time": 45,
          "unhold_label_id": "uuid-string",
          "first_replied_at": "2026-03-30 08:32:05+00",
          "first_replied_time": 125,
          "is_ai_agent_room": false,
          "thread_id": "uuid-string-thread",
          "subject": "Account Sync Issue",
          "cx_log_partition_key": "2026_03",
          "channel": {
            "id": "uuid-string",
            "name": "Klink Asia Facebook",
            "type": "messenger",
            "brand_name": "Klink Official",
            "platform_id": "uuid-string-platform",
            "status": true,
            "created_at": "2024-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T10:00:00.000Z",
            "is_relogin_required": false,
            "connected_user_name": "Klink Support",
            "connected_user_id": "uuid-string-user",
            "actor_id": "uuid-string-actor"
          }
        },
        "wrapUpForm": {
          "id": "uuid-string",
          "disposition": "Resolved",
          "note": "Customer account successfully synced and verified.",
          "createdAt": "2026-03-30T09:12:00.000Z",
          "updatedAt": "2026-03-30T09:15:00.000Z",
          "categories": [
            {
              "id": "uuid-string",
              "value": "Technical Support",
              "parentId": null,
              "level": 1
            },
            {
              "id": "uuid-string",
              "value": "Account Issues",
              "parentId": "uuid-string",
              "level": 2
            }
          ],
          "tags": [
            {
              "id": "uuid-string",
              "name": "First-Contact Resolution"
            }
          ],
          "customFields": [
            {
              "id": "uuid-string",
              "textValue": "v2.5.1",
              "attribute": {
                "id": "uuid-string",
                "displayName": "Software Version",
                "systemName": "software_version",
                "type": "text"
              }
            },
            {
              "id": "uuid-string",
              "textValue": "High",
              "attribute": {
                "id": "uuid-string",
                "displayName": "Urgency Level",
                "systemName": "urgency",
                "type": "select"
              }
            }
          ]
        },
        "holdLogs": [
          {
            "id": "uuid-string",
            "started_at": "2026-03-30 08:45:00.000+00",
            "ended_at": "2026-03-30 08:45:45.000+00",
            "duration": 45,
            "hold_label_id": "uuid-string",
            "cx_log_id": "uuid-string",
            "cx_log_partition_key": "2026_03"
          }
        ],
        "telephonyCdr": null,
        "transcript": "empty"
      }
    ],
    "total": 14,
    "page": 1,
    "pageSize": 14,
    "lastPage": 1
  }
}