/datamarts/{datamart}/statistics

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

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

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

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

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

URL

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

Параметры:

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

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

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

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

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

Тело запроса

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

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

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

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/statistics' \
  -H 'x-request-id: 232dfd40-d803-4d02-b6e2-8b873c15a7b7'

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

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/statistics' \
  -H 'x-request-id: 087aa1f5-07f8-4f06-8ec7-a2d37680dae4' \
  -d ''

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

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/statistics' \
  -H 'x-request-id: 232dfd40-d803-4d02-b6e2-8b873c15a7b7' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

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

curl -X 'POST' \
  'http://localhost:9090/api/v1/datamarts/marketing/statistics' \
  -H 'x-request-id: 087aa1f5-07f8-4f06-8ec7-a2d37680dae4' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c' \
  -d ''

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

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

{
  "statistics": [
  
    ...
  
    {
      "entityCatalog": null,
      "entitySchema": "marketing",
      "entityName": "sales",
      "readCount": 0,
      "readDuration": 0,
      "readErrorCount": 0,
      "firstRead": null,
      "lastRead": null,
      "downloadCount": 0,
      "downloadDuration": 0,
      "downloadErrorCount": 0,
      "firstDownload": null,
      "lastDownload": null,
      "writeCount": 0,
      "writeDuration": 0,
      "writeErrorCount": 0,
      "firstWrite": null,
      "lastWrite": null,
      "uploadCount": 0,
      "uploadDuration": 0,
      "uploadErrorCount": 0,
      "firstUpload": null,
      "lastUpload": null,
      "rowsCount": 31,
      "rowsCountDelta": 34
    },
    {
      "entityCatalog": null,
      "entitySchema": "marketing",
      "entityName": "sales_and_stores",
      "readCount": 0,
      "readDuration": 0,
      "readErrorCount": 0,
      "firstRead": null,
      "lastRead": null,
      "downloadCount": 0,
      "downloadDuration": 0,
      "downloadErrorCount": 0,
      "firstDownload": null,
      "lastDownload": null,
      "writeCount": 0,
      "writeDuration": 0,
      "writeErrorCount": 0,
      "firstWrite": null,
      "lastWrite": null,
      "uploadCount": 0,
      "uploadDuration": 0,
      "uploadErrorCount": 0,
      "firstUpload": null,
      "lastUpload": null,
      "rowsCount": 23,
      "rowsCountDelta": 34
    },
    {
      "entityCatalog": null,
      "entitySchema": "marketing",
      "entityName": "sales_feb_2023",
      "readCount": 0,
      "readDuration": 0,
      "readErrorCount": 0,
      "firstRead": null,
      "lastRead": null,
      "downloadCount": 0,
      "downloadDuration": 0,
      "downloadErrorCount": 0,
      "firstDownload": null,
      "lastDownload": null,
      "writeCount": 0,
      "writeDuration": 0,
      "writeErrorCount": 0,
      "firstWrite": null,
      "lastWrite": null,
      "uploadCount": 0,
      "uploadDuration": 0,
      "uploadErrorCount": 0,
      "firstUpload": null,
      "lastUpload": null,
      "rowsCount": 3,
      "rowsCountDelta": 34
    },
    
    ...

  ]
}