Profiles

Get chat sync

Retrieves a single chat sync run - poll this to follow a backfill to completion. The run is finished when status is completed or failed.

get/api/profiles/{id}/chat_syncs/{chat_sync_id}

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/profiles/{id}/chat_syncs/{chat_sync_id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Profile id

chat_sync_idstring required

Chat sync id

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Response

The chat sync run

idstring

Unique sync identifier.

profile_idstring

Profile this run belongs to.

placement_idstring nullable

Always null for chat syncs.

kind'chats'

Always chats.

trigger'connect' | 'backfill'
status'pending' | 'running' | 'completed' | 'failed'
started_atstring nullable

ISO 8601 timestamp when the run began.

completed_atstring nullable

ISO 8601 timestamp when it finished or failed.

chats_seeninteger

Conversations the platform returned across the run.

messages_importedinteger

Messages that were new and got created. Messages you already have are skipped and not counted.

backfill_fromstring nullable

The date floor requested. null for connect runs.

oldest_updated_atstring nullable

Last-activity time of the oldest conversation the run reached - how far back it has walked.

errorstring nullable

Platform error message when status is failed.

created_atstring

ISO 8601 timestamp.

Changes

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