Get Conversations Statistics

Get conversations statistics allows you to see all the conversations your WhatsApp numbers had during a period of months.

Settings:

URL

https://partners.99digital.co.il/api/whatsapp/getConversationsStatistics

Method

JSON via GET

Header

Authorization: Bearer {{access_token}}

*The access_token can be received from settings->get access token API.


Body:

Parameter

Description / Example

Remarks

start_date

The starting time to get the data in mmyyyy format

for example 032025 for all conversations from March 2025

This is not mandatory.  if you leave it empty, it will not consider any starting date.

end_date

The ending time to get the data in mmyyyy format.

for example 052025 for all conversations until May 2025

This is not mandatory. if you leave it empty, it will not consider any ending date.

whatsapp

Filter by whatsapp number

This is not mandatory, if you leave it empty, you will get all of your whatsapp numbers


We started collecting data at date 122024 so no previous data before this mmyyyy.

Response:


{
    "status": "OK",
    "reason": 1,
    "totalWhatsApp": 2,
    "whatsapp": null,
    "list": [
        {
            "monthYear": "012025",
            "totalConversations": 12530,
            "totalMarketing": 10200,
            "totalService": 1000,
            "totalIncoming": 1330
        },
        {
            "monthYear": "122024",
            "totalConversations": 154320,
            "totalMarketing": 72063,
            "totalService": 12650,
            "totalIncoming": 69607
        }
    ]
}


Response-Explain:

Parameter

Description

status

OK or FAIL

"OK" means the request has been sent to Meta.

"Fail" means error.

totalWhatsApp

The total number of WhatsApp account you manage.

This will show 1 in case you filter by whatsapp number

whatsapp

In case you filter by whatsapp number, this will show the number.

In case you don't filter by whatsapp number, this will show null.

list

array of the following table []:

name

explanation

monthYear

The month in mmyyyy format

totalConversations

The total number of conversation in that month (this includes marketing, service and incoming all together)

totalMarketing

The total number of marketing conversations in that month

totalService

The total number of service conversations in that month

totalIncoming

The total number of incoming conversations in that month

reason

'reason' is the status explanation in case of FAIL

1

not FAIL. the status is OK

2

Wrong credentials

3

Access token does not exist or expired, please generate another one from Settings - Get access token API

28

Either the start_date or end_date is in the wrong format