Statistics

Retrieve one

Endpoint

GET https://zapped.to/api/statistics/{vcard_id}

Authentication

An API key with the statistics:read scope (Read card statistics), sent as Authorization: Bearer YOUR_API_KEY.

Parameters	Details	Description
start_date	Required	Start date in `Y-m-d` format.
end_date	Required	End date in `Y-m-d` format.
type	Optional String	Allowed values: `overview`, `referrer_host`, `referrer_path`, `continent_code`, `country_code`, `city_name`, `os_name`, `browser_name`, `device_type`, `browser_language`, `utm_source`, `utm_medium`, `utm_campaign`, `hour`
country_code	Optional String	Available when: type = city_name
utm_source	Optional String	Available when: type = utm_medium, utm_campaign
utm_medium	Optional String	Available when: type = utm_campaign
referrer_host	Optional String	Available when: type = referrer_path

A range longer than 366 days keeps end_date and starts 366 days before it. Every type other than overview and hour returns at most 500 rows, most viewed first.

Example

curl --request GET \
--url 'https://zapped.to/api/statistics/{vcard_id}?start_date=2020-01-01&end_date=2021-01-01' \
--header 'Authorization: Bearer YOUR_API_KEY' \

Response example

{
    "data": [
        {
            "pageviews": 20,
            "visitors": 5,
            "formatted_date": "2021-01"
        },
        {
            "pageviews": 35,
            "visitors": 10,
            "formatted_date": "2021-02"
        },
        {
            "pageviews": 50,
            "visitors": 25,
            "formatted_date": "2021-03"
        }
    ]
}