API статистики проектов

API для получения статистики по проектам и ключевым словам в системе Revo.

Общая статистика проектов

Получение общей статистики по всем проектам пользователя за последние 24 часа.

Запрос:

GET /api/v1/statistics/projects

Заголовки:

Authorization: Bearer {token}
Accept: application/json

Ответ:

{
    "error": "",
    "result": [
        {
            "id": 1,
            "name": "Мой проект",
            "domain": "example.com",
            "total_successful": 100,
            "total_failed": 10,
            "total_not_found": 5,
            "total_clicks": 115,
            "date": "2025-03-10",
            "created_at": "2025-01-01T00:00:00.000000Z"
        }
    ]
}

Фильтрация статистики проектов

Получение статистики проектов за указанный период.

Запрос:

GET /api/v1/statistics/projects/filter?start_date=2025-03-01&end_date=2025-03-10

Параметры:

• start_date (опционально) - начальная дата в формате YYYY-MM-DD
• end_date (опционально) - конечная дата в формате YYYY-MM-DD

Ответ: аналогичен ответу общей статистики проектов

Детальная статистика проекта

Получение детальной статистики по конкретному проекту.

Запрос:

GET /api/v1/statistics/projects/{id}

Параметры:

• id - ID проекта

Ответ:

{
    "error": "",
    "result": {
        "project": {
            "id": 1,
            "name": "Мой проект",
            "domain": "example.com",
            "created_at": "2025-01-01T00:00:00.000000Z"
        },
        "daily_stats": [
            {
                "date": "2025-03-10",
                "successful_clicks": 100,
                "failed_clicks": 10,
                "not_found_clicks": 5
            }
        ],
        "keyword_stats": [
            {
                "keyword": "ключевое слово",
                "total_successful": 50,
                "total_failed": 5,
                "total_not_found": 2,
                "last_date": "2025-03-10"
            }
        ],
        "period": {
            "start_date": "2025-02-09",
            "end_date": "2025-03-10"
        }
    }
}

Статистика по ключевым словам проекта

Получение статистики по ключевым словам конкретного проекта.

Запрос:

GET /api/v1/statistics/projects/{id}/keywords?start_date=2025-03-01&end_date=2025-03-10

Параметры:

• id - ID проекта
• start_date (опционально) - начальная дата в формате YYYY-MM-DD
• end_date (опционально) - конечная дата в формате YYYY-MM-DD

Ответ:

{
    "error": "",
    "result": {
        "project": {
            "id": 1,
            "name": "Мой проект"
        },
        "keyword_stats": [
            {
                "keyword": "ключевое слово",
                "total_successful": 50,
                "total_failed": 5,
                "total_not_found": 2,
                "last_date": "2025-03-10"
            }
        ],
        "period": {
            "start_date": "2025-03-01",
            "end_date": "2025-03-10"
        }
    }
}

Статистика проекта за конкретную дату

Получение статистики конкретного проекта за определенную дату.

Запрос:

GET /api/v1/statistics/projects/{id}/date/{date}

Параметры:

• id - ID проекта
• date - дата в формате YYYY-MM-DD

Ответ:

{
    "error": "",
    "result": {
        "project": {
            "id": 1,
            "name": "Мой проект",
            "domain": "example.com",
            "created_at": "2025-01-01T00:00:00.000000Z"
        },
        "stats": {
            "total_successful": 100,
            "total_failed": 10,
            "total_not_found": 5,
            "total_clicks": 115,
            "date": "2025-03-10"
        },
        "keywords": [
            {
                "keyword": "ключевое слово",
                "successful": 50,
                "failed": 5,
                "not_found": 2,
                "total_clicks": 57,
                "date": "2025-03-10"
            }
        ]
    }
}

Структуры данных

Статистика проекта

Поле	Тип	Описание
id	integer	ID проекта
name	string	Название проекта
domain	string	Домен проекта
total_successful	integer	Количество успешных кликов
total_failed	integer	Количество неудачных кликов
total_not_found	integer	Количество кликов "не найдено"
total_clicks	integer	Общее количество кликов
date	string	Дата статистики
created_at	string	Дата создания проекта

Статистика ключевого слова

Поле	Тип	Описание
keyword	string	Ключевое слово
successful	integer	Количество успешных кликов
failed	integer	Количество неудачных кликов
not_found	integer	Количество кликов "не найдено"
total_clicks	integer	Общее количество кликов
date	string	Дата статистики