Skip to main content
Skip table of contents

Get a list of intercom events

Getting a list of intercom events

Receiving a list of intercom events.

Permission for this route - events-index

GET /api/admin/v1/intercoms/{intercom}/events

The parameters

int intercom, Unique identifier of the intercom


int per_page, Number of elements in one pagination page.


int page, Pagination page number


string group REQUIRED, Group of intercom events.


string sort, Sorting parameter.


string dir, In which direction to sort.


date from, Start date.


date to, End date.


array types, Event types


array users, List of user ids.

200 OK

Successful response

JSON
{
    "data": [
        {
            "type": "admin.intercom.store",
            "type_pretty": "models.events.intercom_logs.admin.intercom.store",
            "data": null,
            "count": null,
            "user": {
                "id": 12,
                "name": "170500",
                "login": "170500",
                "created_by": null,
                "created_at": "2023-12-19T12:10:43.000000Z",
                "updated_at": "2023-12-19T12:10:43.000000Z",
                "expired_at": null,
                "user_type": "user",
                "parent_id": null,
                "is_system": 0,
                "cameras_count": null,
                "is_licence_limit_reached": true,
                "ptz_priority": 10,
                "access_token_id": null
            },
            "created_at": "2023-12-20T16:44:32.000000Z",
            "updated_at": "2023-12-20T16:44:34.000000Z",
            "intercom": {
                "id": 1,
                "title": "Sputnik1",
                "is_online": true,
                "is_registered": null,
                "group_id": 1,
                "camera_id": 28,
                "flat_from": 1,
                "flat_to": 100,
                "flat_offset": null,
                "department": 1,
                "department_name": "main",
                "department_type": "main",
                "department_type_pretty": "Main entrance",
                "uuid": "2d68b836-6f27-4650-8dae-9e80ff9bd26f",
                "address": "vbvbvbv",
                "created_at": "2023-05-10T15:56:14.000000Z",
                "updated_at": "2023-11-14T11:39:16.000000Z",
                "mac": null,
                "vendor": "sputnik",
                "vendor_pretty": "Sputnik",
                "status": "installed",
                "status_pretty": "Installed",
                "switch": "metakom",
                "switch_pretty": "Metacom",
                "schema": null,
                "ip": null,
                "port": null,
                "login": "<null>",
                "password": "<null>",
                "commutators_count": 1,
                "connection_type": "fixed_and_smart",
                "connection_type_pretty": "Combo 2",
                "key_count": null,
                "is_analytic_available": true
            }
        }
    ],
    "links": {
        "first": "https://vms.local:8084/api/admin/v1/intercoms/1/events?per_page=100&group=intercom_logs&from=2023-12-20T07%3A00%3A00Z&to=2023-12-21T07%3A00%3A00Z&page=1",
        "last": "https://vms.local:8084/api/admin/v1/intercoms/1/events?per_page=100&group=intercom_logs&from=2023-12-20T07%3A00%3A00Z&to=2023-12-21T07%3A00%3A00Z&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local:8084/api/admin/v1/intercoms/1/events?per_page=100&group=intercom_logs&from=2023-12-20T07%3A00%3A00Z&to=2023-12-21T07%3A00%3A00Z&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8084/api/admin/v1/intercoms/1/events",
        "per_page": 100,
        "to": 1,
        "total": 1
    }
}

401 Unauthorized

Authorization token not sent or not valid

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/{intercom}/events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "intercom": 0,
    "per_page": 0,
    "page": 0,
    "group": "string",
    "sort": "string",
    "dir": "string",
    "from": "date",
    "to": "date",
    "types": [],
    "users": []
}'
PHP
PHP
$data = array (
  'intercom' => 0,
  'per_page' => 0,
  'page' => 0,
  'group' => 'string',
  'sort' => 'string',
  'dir' => 'string',
  'from' => 'date',
  'to' => 'date',
  'types' => 
  array (
  ),
  'users' => 
  array (
  ),
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/intercoms/{intercom}/events', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.