Stat API

Где получить ключ

Подробное описание request-response по каждому эндпойнту.

Список эндпойнтов:

Method	Path	Description
OPTIONS	/api/stat/get	список метрик и группировок
PUT	/api/stat/get	создание или сохранение отчета
POST	/api/stat/get	список отчётов
POST	/api/stat/get/id/{id}	информация об отчёте
DELETE	/api/stat/get/id/{id}	удаление отчёта
POST	/api/stat/filter	получение данных для фильтра
POST	/api/stat/data	получение данных для таблицы
POST	/api/stat/share	cохранение отчёта для шаринга
GET	/api/stat/share/id/{id}	получение отчёта для шаринга

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

CURL

curl -X 'OPTIONS' \ 'https://dev.kaminari.click/api/stat/get' \ -H 'accept: */*' 'Authorization: Bearer API_TOKEN'

curl -X POST 'https://dev.kaminari.click/api/stat/filter' -d '{"id":"device_type","searchQuery":"","dateFrom":"2023-01-05","dateTo":"2023-01-05"}' -H 'content-type: application/json' -H 'Authorization: Bearer API_TOKEN'

curl -X POST 'https://dev.kaminari.click/api/stat/data' -d '{"id":null,"name":null,"groups":["time_day"],"metrics":["summary_totalVisits"],"filters":{"filters":[],"period":null,"timezone":0,"dateTo":"2022-08-15","dateFrom":"2022-08-15"},"compare":null}' -H 'content-type: application/json' -H 'Authorization: Bearer API_TOKEN'

NodeJS

<const https = require('https');

const options = {
    host: 'dev.kaminari.click',
    port: 443,
    path: '/api/stat/get',
    method: 'POST',
    headers: { 'Authorization': 'Bearer API_TOKEN' }
};

https
    .get(options, (resp) => {
        let data = '';

        resp.on('data', (chunk) => {
            data += chunk;
        });

        resp.on('end', () => {
            try {
                data = JSON.parse(data);
            } catch {
                console.log(data);
            }
        });
    })
    .on("error", (err) => {
        console.log("Error: " + err.message);
    });