Аналитика

Получение аналитики по платежам

GET /api/v2/analytics

cURL

curl -X GET "https://loveandpay.io/api/v2/analytics?startDate=2024-01-01&endDate=2024-01-31&groupBy=day" \
  -H "x-api-key: pk_live_xxx" \
  -H "x-timestamp: 1706012345678" \
  -H "x-signature: a1b2c3d4e5f6..."

200

{
  "success": true,
  "analytics": {
    "totalRevenue": 150000,
    "totalTransactions": 50,
    "averageAmount": 3000,
    "conversionRate": 0.75,
    "invoiceCount": 67,
    "paidCount": 50,
    "expiredCount": 10,
    "cancelledCount": 7,
    "timeline": [
      {
        "date": "2024-01-21",
        "revenue": 45000,
        "transactions": 15,
        "invoices": 20
      },
      {
        "date": "2024-01-22",
        "revenue": 60000,
        "transactions": 20,
        "invoices": 25
      },
      {
        "date": "2024-01-23",
        "revenue": 45000,
        "transactions": 15,
        "invoices": 22
      }
    ],
    "topCustomers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "fullName": "Иван Иванов",
        "totalAmount": 25000,
        "paymentCount": 8
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "fullName": "Мария Петрова",
        "totalAmount": 20000,
        "paymentCount": 6
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440002",
        "fullName": "Алексей Сидоров",
        "totalAmount": 15000,
        "paymentCount": 5
      }
    ]
  }
}

Заголовки

x-api-key · string · required

Ваш API ключ

x-timestamp · string · required

Unix timestamp в миллисекундах

x-signature · string · required

HMAC-SHA256 подпись

Query параметры

startDate · string

Начало периода в формате YYYY-MM-DD

endDate · string

Конец периода в формате YYYY-MM-DD

groupBy · string · default: "day"

Группировка данных: day, week, month

200

{
  "success": true,
  "analytics": {
    "totalRevenue": 150000,
    "totalTransactions": 50,
    "averageAmount": 3000,
    "conversionRate": 0.75,
    "invoiceCount": 67,
    "paidCount": 50,
    "expiredCount": 10,
    "cancelledCount": 7,
    "timeline": [
      {
        "date": "2024-01-21",
        "revenue": 45000,
        "transactions": 15,
        "invoices": 20
      },
      {
        "date": "2024-01-22",
        "revenue": 60000,
        "transactions": 20,
        "invoices": 25
      },
      {
        "date": "2024-01-23",
        "revenue": 45000,
        "transactions": 15,
        "invoices": 22
      }
    ],
    "topCustomers": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "fullName": "Иван Иванов",
        "totalAmount": 25000,
        "paymentCount": 8
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "fullName": "Мария Петрова",
        "totalAmount": 20000,
        "paymentCount": 6
      },
      {
        "id": "550e8400-e29b-41d4-a716-446655440002",
        "fullName": "Алексей Сидоров",
        "totalAmount": 15000,
        "paymentCount": 5
      }
    ]
  }
}

cURL

curl -X GET "https://loveandpay.io/api/v2/analytics?startDate=2024-01-01&endDate=2024-01-31&groupBy=day" \
  -H "x-api-key: pk_live_xxx" \
  -H "x-timestamp: 1706012345678" \
  -H "x-signature: a1b2c3d4e5f6..."

---

Описание полей

Поле	Описание
totalRevenue	Общая выручка за период (₽)
totalTransactions	Количество успешных платежей
averageAmount	Средний чек (₽)
conversionRate	Конверсия (оплаченные / созданные)
invoiceCount	Всего создано счетов
paidCount	Оплачено счетов
expiredCount	Истекло счетов
cancelledCount	Отменено счетов

Timeline

Массив timeline содержит данные по каждому периоду:

Поле	Описание
date	Дата (или начало недели/месяца)
revenue	Выручка за период
transactions	Количество платежей
invoices	Количество созданных счетов

Top Customers

Массив topCustomers содержит топ-клиентов по сумме платежей:

Поле	Описание
id	UUID клиента
fullName	Имя клиента
totalAmount	Общая сумма платежей
paymentCount	Количество платежей