Visitors

API Documentation

Endpoint
GET https://dev.usermetric.io/api/visitors/
Parameters
Parameters Details Description
page
Optional Integer
The page number that you want results from. Defaults to 1.
results_per_page
Optional Integer
How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25.
Example
curl --request GET \
  --url 'https://dev.usermetric.io/api/visitors/' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": [
        {
            "id": 1,
            "visitor_uuid": "4b3a71aeed5a4400913b84f38a11b6bf",
            "website_id": 1,
            "goals_conversions_ids": [1, 2],
            "ip": "127.0.0.1",
            "custom_parameters": {
                "name": "John Doe",
                "email": "john@example.com"
            },
            "continent_code": "EU",
            "country_code": "IT",
            "city_name": "Rome",
            "os_name": "OS X",
            "os_version": "10.15",
            "browser_name": "Chrome",
            "browser_version": "120.0",
            "browser_language": "en",
            "browser_timezone": "Europe/Bucharest",
            "device_type": "desktop",
            "theme": "light",
            "total_sessions": 3,
            "last_event_id": 1,
            "last_date": "2026-09-22 02:53:13",
            "date": "2026-09-22 02:53:13"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://dev.usermetric.io/api/visitors?page=1",
        "last": "https://dev.usermetric.io/api/visitors?page=1",
        "next": null,
        "prev": null,
        "self": "https://dev.usermetric.io/api/visitors?page=1"
    }
}

Endpoint
GET https://dev.usermetric.io/api/visitors/{visitor_id}
Example
curl --request GET \
  --url 'https://dev.usermetric.io/api/visitors/{visitor_id}' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": {
        "id": 1,
        "visitor_uuid": "4b3a71aeed5a4400913b84f38a11b6bf",
        "website_id": 1,
        "goals_conversions_ids": [1, 2],
        "ip": "127.0.0.1",
        "custom_parameters": {
            "name": "John Doe",
            "email": "john@example.com"
        },
        "continent_code": "EU",
        "country_code": "IT",
        "city_name": "Rome",
        "os_name": "OS X",
        "os_version": "10.15",
        "browser_name": "Chrome",
        "browser_version": "120.0",
        "browser_language": "en",
        "browser_timezone": "Europe/Bucharest",
        "device_type": "desktop",
        "theme": "light",
        "total_sessions": 3,
        "last_event_id": 1,
        "last_date": "2026-09-22 02:53:13",
        "date": "2026-09-22 02:53:13"
    }
}

Endpoint
POST https://dev.usermetric.io/api/visitors/{visitor_id or visitor_uuid}
Parameters
Parameters Details Description
custom_parameter_key[index]
Optional String
custom_parameter_value[index]
Optional String
Example
curl --request POST \
  --url 'https://dev.usermetric.io/api/visitors/{visitor_id or visitor_uuid}' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'custom_parameter_key[0]=name' \
  --form 'custom_parameter_value[0]=John Doe' \
Response example
{
    "data": {
        "id": 1,
        "visitor_uuid": "4b3a71aeed5a4400913b84f38a11b6bf",
        "website_id": 1,
        "goals_conversions_ids": [1, 2],
        "ip": "127.0.0.1",
        "custom_parameters": {
            "name": "John Doe",
            "email": "john@example.com"
        },
        "continent_code": "EU",
        "country_code": "IT",
        "city_name": "Rome",
        "os_name": "OS X",
        "os_version": "10.15",
        "browser_name": "Chrome",
        "browser_version": "120.0",
        "browser_language": "en",
        "browser_timezone": "Europe/Bucharest",
        "device_type": "desktop",
        "theme": "light",
        "total_sessions": 3,
        "last_event_id": 1,
        "last_date": "2026-09-22 02:53:13",
        "date": "2026-09-22 02:53:13"
    }
}

Endpoint
DELETE https://dev.usermetric.io/api/visitors/{visitor_id or visitor_uuid}
Example
curl --request DELETE \
  --url 'https://dev.usermetric.io/api/visitors/{visitor_id or visitor_uuid}' \
  --header 'Authorization: Bearer {api_key}' \