GET
/
projects
/
{projectId}
/
conversations

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

projectId
string
required

The ID of the project

Query Parameters

startDate
string

Date in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)

endDate
string

Date in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)

record
boolean

Whether to return conversations that are set to be recorded

interacted
boolean

Whether to return conversations that have user interaction

Response

200 - application/json
_id
string

The ID of the conversation

platformId
string

The ID of the conversation from the original platform (e.g. Voiceflow transcriptID, OpenAI thread_id)

name
string

The name of the user who created the conversation

read:
boolean

Whether the conversation has been read

endedAt
string

The date and time the conversation ended (ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ)

browser
string

The browser used for the conversation

device
string

The device used for the conversation

os
string

The operating system used for the conversation

countryCode
string

The country code associated with the user's location (ISO 3166-1 alpha-2)

ipAddress
string

The IP address of the User

record
boolean

Whether to record the conversation

interacted
boolean

Whether there is user interaction in the conversation

channel
string

The channel where the conversation took place (Webchat, WhatsApp, Instagram)

phone
string

The phone number of the user for WhatsApp conversations

instagramId
string

The Instagram ID of the user for Instagram conversations

instagramUsername
string

The Instagram username of the user for Instagram conversations