Events children

API Documentation

Endpoint
GET https://dev.usermetric.io/api/events-children/
Parameters
Parameters Details Description
website_id
Required Integer
event_id
Optional Integer
session_id
Optional Integer
visitor_id
Optional Integer
type
Optional String
Allowed values: click, scroll, resize, form
datetime_field
Optional String
Allowed values: date, expiration_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: id, event_id, session_id, visitor_id, type, count, expiration_date, 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/events-children/?website_id=1' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": [
        {
            "id": 1,
            "event_id": 1,
            "session_id": 1,
            "visitor_id": 1,
            "website_id": 1,
            "type": "click",
            "data": {
                "text": "Button"
            },
            "count": 1,
            "expiration_date": "2027-09-22",
            "datetime": "2026-09-22 02:54:20"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://dev.usermetric.io/api/events-children?website_id=1&page=1",
        "last": "https://dev.usermetric.io/api/events-children?website_id=1&page=1",
        "next": null,
        "prev": null,
        "self": "https://dev.usermetric.io/api/events-children?website_id=1&page=1"
    }
}

Endpoint
GET https://dev.usermetric.io/api/events-children/{id}
Example
curl --request GET \
  --url 'https://dev.usermetric.io/api/events-children/{id}' \
  --header 'Authorization: Bearer {api_key}' \
Response example
{
    "data": {
        "id": 1,
        "event_id": 1,
        "session_id": 1,
        "visitor_id": 1,
        "website_id": 1,
        "type": "click",
        "data": {
            "text": "Button"
        },
        "count": 1,
        "expiration_date": "2027-09-22",
        "datetime": "2026-09-22 02:54:20"
    }
}

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