Analytics еvents

Analytics events

The permission for this route is analytic-servers-index

GET /api/admin/v1/analytic/ovms/events

Parameters

int per_page, Number of elements in one pagination page.

string sort, Sorting is done by date and analytics type

string dir, In which direction to sort.

array analytic_types, Analytics type

array types, Event type

date from, Start date

date to, End date

200 OK

Successful response

JSON

{
    "data": [
        {
            "uuid": null,
            "type": "ovms.object_limit_exceeded",
            "type_pretty": "Connection error when accessing model. Timeout exceeded",
            "analytic_type": null,
            "analytic_type_pretty": null,
            "created_at": "2023-09-07T11:35:38.000000Z",
            "data": {
                "job_uid": "ca9a25e2-4265-11ee-9ac8-d326cd567023",
                "error_code": "424",
                "worker_uid": "ca9a25e2-4265-11ee-9ac8-d326cd567024",
                "worker_name": "WORKER 1",
                "start_timestamp": "2023-08-01T07%3A17%3A38.000000Z",
                "finish_timestamp": "2023-08-02T07%3A17%3A38.000000Z",
                "error_description": "Connection error when accessing model. Timeout exceeded"
            }
        },
        {
            "uuid": "ca9a25e2-4265-11ee-9ac8-d326cd567023",
            "type": "ovms.gateway_timeout",
            "type_pretty": "Connection error when accessing model. Timeout exceeded",
            "analytic_type": "face-recognition",
            "analytic_type_pretty": "Face Recognition",
            "created_at": "2023-09-07T08:18:59.000000Z",
            "data": {
                "job_uid": "ca9a25e2-4265-11ee-9ac8-d326cd567023",
                "error_code": "504",
                "worker_uid": "ca9a25e2-4265-11ee-9ac8-d326cd567024",
                "worker_name": "WORKER 1",
                "start_timestamp": "2023-08-01T07%3A17%3A38.000000Z",
                "finish_timestamp": "2023-08-02T07%3A17%3A38.000000Z",
                "error_description": "Connection error when accessing model. Timeout exceeded"
            }
        }
    ],
    "links": {
        "first": "https://vms.local:8000/api/admin/v1/analytic/ovms/events?page=1",
        "last": "https://vms.local:8000/api/admin/v1/analytic/ovms/events?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:8000/api/admin/v1/analytic/ovms/events?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8000/api/admin/v1/analytic/ovms/events",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}

401 Unauthorized

Authorization token not sent or not valid

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/analytic/ovms/events' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "per_page": 0,
    "sort": "string",
    "dir": "string",
    "analytic_types": [],
    "types": [],
    "from": "date",
    "to": "date"
}'

PHP

$data = array (
  'per_page' => 0,
  'sort' => 'string',
  'dir' => 'string',
  'analytic_types' => 
  array (
  ),
  'types' => 
  array (
  ),
  'from' => 'date',
  'to' => 'date',
);
$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/analytic/ovms/events', false, $context);