/datamarts/{datamart}/entities/{entity}/statistics

Содержание раздела

1. URL
2. Заголовки запроса
3. Тело запроса
4. Примеры CURL-запросов
   1. GET-запрос без авторизационного токена
   2. POST-запрос без авторизационного токена
   3. GET-запрос с авторизационным токеном
   4. POST-запрос с авторизационным токеном
   5. Ответ на GET-запрос

Доступны следующие методы:

• GET — возвращает статистику обработки запросов по логической сущности {entity};
• POST — обнуляет статистику обработки запросов по логической сущности {entity}.

GET-метод в ответе возвращает параметры, описанные в разделе GET_ENTITY_STATISTICS.

URL

{baseUrl}/api/v1/datamarts/{datamart}/entities/{entity}/statistics

Параметры:

• baseUrl — путь для подключения к серверу ноды Prostore (IP-адрес или доменное имя и номер порта);
• datamart — имя логической базы данных, которой принадлежит логическая сущность;
• entity — имя логической сущности, по которой запрашивается или обнуляется статистика.

Заголовки запроса

Поддерживаются следующие типы заголовков:

• x-request-id (опциональный) — задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе;
• Authorization (опциональный) — задает тип аутентификации и авторизационный токен (JWT). Возможное значение типа аутентификации — Bearer.

Подробнее об аутентификации запросов см. в разделе Аутентификация.

Тело запроса

Тело запроса отсутствует.

Примеры CURL-запросов

GET-запрос без авторизационного токена

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales/statistics' \
  -H 'x-request-id: 7cf843da-fef7-45cf-8d81-cdccfc57b662'

POST-запрос без авторизационного токена

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales/statistics' \
  -H 'x-request-id: 62f86c70-1916-4842-965c-f080c96a6818' \
  -d ''

GET-запрос с авторизационным токеном

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales/statistics' \
  -H 'x-request-id: 7cf843da-fef7-45cf-8d81-cdccfc57b662' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

POST-запрос с авторизационным токеном

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales/statistics' \
  -H 'x-request-id: 62f86c70-1916-4842-965c-f080c96a6818' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
  -d ''

Ответ на GET-запрос

Фрагмент примера ответа:

{
  "statistics": {
    "entityCatalog": null,
    "entitySchema": "marketing",
    "entityName": "sales",
    "readCount": 21,
    "readDuration": 800,
    "readErrorCount": 2,
    "firstRead": "2023-09-13 13:54:27.66",
    "lastRead": "2023-09-13 14:25:40.42",
    "downloadCount": 0,
    "downloadDuration": 0,
    "downloadErrorCount": 0,
    "firstDownload": null,
    "lastDownload": null,
    "writeCount": 0,
    "writeDuration": 0,
    "writeErrorCount": 1,
    "firstWrite": "2023-09-13 14:24:31.774",
    "lastWrite": "2023-09-13 14:24:31.774",
    "uploadCount": 0,
    "uploadDuration": 0,
    "uploadErrorCount": 0,
    "firstUpload": null,
    "lastUpload": null,
    "rowsCount": 31,
    "rowsCountDelta": 34
  }
}