Получение статистики

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

1. URL
2. Заголовки запроса
3. Тело запроса
4. Примеры запросов
   1. Запрос статистики по одной сущности
   2. Запрос статистики по сущностям логической БД
   3. Запрос статистики по сущностям окружения

Доступны GET-методы для получения статистики по следующим сущностям:

• по указанной логической сущности,
• по логическим сущностям указанной логической базы данных,
• по логическим сущностям всех логических БД текущего окружения.

В ответе возвращаются параметры статистики, описанные в разделе GET_ENTITY_STATISTICS.

URL

• {baseUrl}/api/v1/datamarts/{datamart}/entities/{entity}/statistics — получение статистики по сущности {entity} в логической БД {datamart};
• {baseUrl}/api/v1/datamarts/{datamart}/statistics — получение статистики по сущностям логической БД {datamart};
• {baseUrl}/api/v1/datamarts/all/statistics — получение статистики по сущностям всех логических БД текущего окружения.

Параметры:

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

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

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

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

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

Тело запроса

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

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

Запрос статистики по одной сущности

Запрос без авторизационного токена:

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

Запрос с авторизационным токеном:

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/entities/sales/statistics' \
  -H 'x-request-id: 91e6032f-f00d-4e37-822d-6170179e15d0' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

Ответ:

{
  "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
  }
}

Запрос статистики по сущностям логической БД

Запрос без авторизационного токена:

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

Запрос с авторизационным токеном:

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/marketing/statistics' \
  -H 'x-request-id: dcee0de0-bc11-4290-824b-d16e9f599ec5' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

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

{
  "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
    },
    
    ...

  ]
}

Запрос статистики по сущностям окружения

Запрос без авторизационного токена:

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/all/statistics' \
  -H 'x-request-id: 300391c4-d8bd-42ab-9d84-d61194933cfe'

Запрос с авторизационным токеном:

curl -X 'GET' \
  'http://localhost:9090/api/v1/datamarts/all/statistics' \
  -H 'x-request-id: 2778a29a-f638-444e-8013-7854c7b02f7a' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

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

{
  "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_new",
      "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": 14,
      "rowsCountDelta": 7
    },
    {
      "entityCatalog": null,
      "entitySchema": "moscow",
      "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": 6,
      "rowsCountDelta": 2
    }
  ]
}