Page tree

Citypoint - контроль и аналитика автопарка

Skip to end of metadata
Go to start of metadata

Метод возвращает статистику по уведомлениям c разбивкой по часам, типу события, уровню.

Запрос:

URL:

https://api.url/v2.1/user/<user_id>/notifications/statistics/<DateTimeFrom>/<DateTimeTo>

Доп. Заголовки:

Accept - Указание формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

ПолеТипЗначение по умолчаниюОписание
fields[notificationEvent]string

Фильтрация полей объектов.

Структура объекта:

ПолеТипNullableОписание
idstringнет

Идентификатор

typestringнетТип. всегда notificationStatistic
attributesobjectнетАтрибуты

Атрибуты:

ПолеТипNullableОписание
DateDateTimeнетДата на которую описана статистика
LevelintнетУровень важности уведомлений
Newintнетчисло не прочитанных уведомлений.
Readintнетчисло прочитанных увдеомлений.
Archivedintнетчисло архивных уведомлений.

Связанные объкты:

ПолетипNullableОписание
NotificationEventobjectнетNotificationsEvents - тип события

Пример:

GET https://api.url/v2.1/user/1/notifications/statistics/2021-02-01T21:00:00Z/2021-02-2T21:00:00Z HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "data":[
        {
            id: 'base-1-2-20210201T210000',
            type: 'notificationStatistic',
            attributes:{
                Date: '2021-02-01T21:00:00Z',
                Level: 2,
                New: 14,
                Read: 3,
                Archived: 0
            },
            relationships:{
                NotificationEvent: {
                    data: { type: "notificationEvent", id: "base-1"}
                }

            }
        },
        {
            id: 'base-1-2-20210201T220000',
            type: 'notificationStatistic',
            attributes:{
                Date: '2021-02-01T22:00:00Z',
                Level: 2,
                New: 42,
                Read: 2,
                Archived: 0
            },
            relationships:{
                NotificationEvent: {
                    data: { type: "notificationEvent", id: "base-1"}
                }
            }
        },
        {
            id: 'log-2-5-20210201T210000',
            type: 'notificationStatistic',
            attributes:{
                Date: '2021-02-01T21:00:00Z',
                Level: 5,
                New: 42,
                Read: 2,
                Archived: 0
            },
            relationships:{
                NotificationEvent: {
                    data: { type: "notificationEvent", id: "log-2"}
                }
            }
        },
    ]
}
  • No labels