Sessions

API Documentation

Endpoint
GET https://dev.usermetric.io/api/sessions/
Parameters
Parameters Details Description
website_id
Required Integer
visitor_id
Optional Integer
datetime_field
Optional String
Allowed values: date
datetime_start
Optional String
Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end
Optional String
Filter results up to this datetime. Y-m-d H:i:s format.
order_by
Optional String
What field to order the results by. Allowed values are: session_id, visitor_id, total_events, date.
order_type
Optional String
The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering.
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/sessions/?website_id=1' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": [
        {
            "id": 1,
            "session_uuid": "4b3a71aeed5a4400913b84f38a11b6bf",
            "visitor_id": 1,
            "website_id": 1,
            "total_events": 3,
            "datetime": "2026-09-22 02:52:55"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://dev.usermetric.io/api/sessions?website_id=1&page=1",
        "last": "https://dev.usermetric.io/api/sessions?website_id=1&page=1",
        "next": null,
        "prev": null,
        "self": "https://dev.usermetric.io/api/sessions?website_id=1&page=1"
    }
}

Endpoint
GET https://dev.usermetric.io/api/sessions/{session_id}
Example
curl --request GET \
  --url 'https://dev.usermetric.io/api/sessions/{session_id}' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": {
        "id": 1,
        "session_uuid": "4b3a71aeed5a4400913b84f38a11b6bf",
        "visitor_id": 1,
        "website_id": 1,
        "total_events": 3,
        "datetime": "2026-09-22 02:52:55"
    }
}

Endpoint
DELETE https://dev.usermetric.io/api/sessions/{session_id}
Example
curl --request DELETE \
  --url 'https://dev.usermetric.io/api/sessions/{session_id}' \
  --header 'Authorization: Bearer {api_key}' \