Collecting the conversation and users-reg

Product
1

Hi,
I am looking for the followings and if you help me in this regards it would be a great helpful for me.

  1. Getting all the conversations from my freshchat account without using the conversation ID.
  2. Getting all the users from my freshchat account without using the user ID.

Thanks a lot.

2

@Radha_S,
Good Day! Welcome to the community!
I think it is not possible as per the API docs, mean while let me check with the product team and get back to you at the earliest

Thanks

3

@Radha_S You can use the Extract APIs to get a list of conversation and the users who initiated these conversations in a specific time period.

There are 2 steps for exporting this data via API.

Step1 : API call to create a data export request -

curl --location --request POST 'https://api.freshchat.com/v2/reports/raw/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-TOKEN>' \
--data-raw '{
    "start": "2021-04-01T00:00:00.000Z",
    "end"  : "2021-04-02T00:00:00.000Z",
    "event": "classic",
    "format": "csv"
}'

Response:

{
    "id": "25b1bec7-4c83-4069-74yd-89ab417b800d",
    "link": {
        "rel": "extracts",
        "href": "/reports/raw/25b1bec7-4c83-4069-74yd-89ab417b800d"
    }
}

Step2 : API call to check the status of the data export request and get a signed link to download this data as a csv file. Use the id that you received from the API call made in Step1.

curl --location --request GET 'https://api.freshchat.com/v2/reports/raw/25b1bec7-4c83-4069-74yd-89ab417b800d' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API-TOKEN>'

Response:

{
    "id": "25b1bec7-4c83-4069-74yd-89ab417b800d",
    "status": "COMPLETED",
    "interval": "2021-04-01 00:00:00.0 2021-04-02 00:00:00.0",
    "links": [
        {
            "link": {
                "rel": "raw_reports",
                "href": "<link-to-download-csv-file>"
            },
            "from": "2021-04-01T00:00:00.000Z",
            "to": "2021-04-02T00:00:00.000Z",
            "status": "COMPLETED"
        }
    ]
}

Within this csv file, you can refer to the columns conversation_alias and user_id

Note:

  • You can pass a start & end timestamp in UTC timezone to the API call in step1 to get the list of users & conversations for a specific time period.
  • This specific report type allows you to export data only for a 24hr time period with each API call. You might have to make multiple API calls to export data for multiple days
  • Developer docs: Freshchat
  • There are other report types that allow you to export data for a longer time frame(1 month) with a single API call:
    • conversation-created - Gives you a list of conversations that were initiated in the specified time period.
    • conversation-resolved - Gives you a list of conversations that were resolved in a specified time period.
1 Like