Contacts statistics

Retrieve one

Endpoint

GET https://smsgateway.webgradee.com/api/contacts-statistics/

Parameters	Details	Description
start_date	Optional String	Start date in `Y-m-d` format. Defaults to `30 days ago` if omitted.
end_date	Optional String	End date in `Y-m-d` format. Defaults to `today` if omitted.
type	Optional String	Allowed values: `overview`, `continent_code`, `country_code`, `has_opted_out`, `activity`, `timezone`, `phone_type`

Example

curl --request GET \
--url 'https://smsgateway.webgradee.com/api/contacts-statistics?start_date=2026-09&end_date=2026-11-01' \
--header 'Authorization: Bearer {api_key}' \

Response example

{
    "data": [
        {
            "contacts": 20,
            "formatted_date": "2026-09"
        },
        {
            "contacts": 35,
            "formatted_date": "2026-10"
        },
        {
            "contacts": 50,
            "formatted_date": "2026-11"
        }
    ]
}

Response example - type = activity

{
    "data": [
        {
            "activity_bucket": "active_today",
            "contacts": 25
        },
        {
            "activity_bucket": "inactive",
            "contacts": 40
        }
    ]
}

Response example - type = timezone

{
    "data": [
        {
            "timezone": "Europe/Bucharest",
            "utc_offset": "UTC+03:00",
            "contacts": 20
        },
        {
            "timezone": "multiple_timezones",
            "utc_offset": "",
            "contacts": 35
        }
    ]
}

Response example - type = phone_type

{
    "data": [
        {
            "phone_type": "mobile",
            "contacts": 25
        },
        {
            "phone_type": "fixed_line_or_mobile",
            "contacts": 40
        }
    ]
}