Skip to main content
GET
Получение данных об использовании проекта

Обзор

Возвращает полную информацию о расходовании кредитов проекта за текущий кредитный цикл, включая остаток кредитов, сведения о плане подписки и разбивку запросов по типам сервисов (RPC, DAS, gRPC, WebSocket и т. д.). Все данные о кредитах относятся к creditCycle — периоду, в течение которого кредиты накапливаются и по окончании которого сбрасываются. Этот период определяется датой начала выставления счетов по подписке. Он есть у каждого проекта, включая проекты с бесплатными планами. subscriptionDetails.billingCycle — это период выставления счетов; он приводится только для информации и имеет значение null для бесплатных планов, по которым счета никогда не выставляются.

Параметры запроса

string
обязательно
Идентификатор проекта, для которого нужно получить данные об использовании. Должен совпадать с проектом, связанным с API-ключом, который используется для аутентификации.

Поля ответа

number
Количество кредитов, оставшихся в текущем кредитном цикле. Рассчитывается как лимит кредитов плана за вычетом израсходованных обычных кредитов, но не может быть меньше нуля.
number
Общее количество кредитов, израсходованных в текущем кредитном цикле, включая обычные и предоплаченные кредиты.
number
Количество доступных предоплаченных кредитов.
number
Количество предоплаченных кредитов, израсходованных в текущем кредитном цикле.
object
Период, к которому относятся все данные о кредитах в этом ответе. В течение этого периода кредиты накапливаются, а по его окончании сбрасываются. Период определяется датой начала выставления счетов по подписке. Всегда присутствует для любого плана, включая бесплатные.
string
Дата начала кредитного цикла в формате YYYY-MM-DD (UTC).
string
Дата окончания кредитного цикла в формате YYYY-MM-DD (UTC).
object
Информация о плане подписки и цикле выставления счетов.
object | null
Даты начала и окончания текущего цикла выставления счетов. Приводятся только для информации. Для бесплатных планов, по которым счета никогда не выставляются, значение равно null. Для платных планов этот цикл обычно совпадает с creditCycle.
string
Дата начала цикла выставления счетов в формате YYYY-MM-DD.
string
Дата окончания цикла выставления счетов в формате YYYY-MM-DD.
number
Общее количество кредитов, доступных в течение кредитного цикла согласно вашему плану.
string
Название плана подписки (например, "business", "professional").
object
Расход кредитов по каждому продукту за текущий кредитный цикл, выраженный в целых кредитах. Охватывает все продукты. Исходные значения суммируются и округляются один раз в конце для соответствия данным биллинга, поэтому после округления сумма кредитов по продуктам может не совпадать в точности с creditsUsed.
number
Кредиты, израсходованные стандартным Solana RPC.
number
Кредиты, израсходованные Enhanced API (например, на разобранные транзакции и метаданные токенов).
number
Кредиты, израсходованные Wallet API.
number
Кредиты, израсходованные API DAS (Digital Asset Standard).
number
Кредиты, израсходованные вебхуками.
number
Кредиты, израсходованные LaserStream gRPC с тарификацией по объему переданных данных.
number
Кредиты, израсходованные LaserStream WebSocket с тарификацией по объему переданных данных.
number
Кредиты, израсходованные Preconfirmations.
number
Кредиты, израсходованные Archival.
number
Кредиты, израсходованные Photon (ZK-сжатие).
number
Кредиты, израсходованные на использование без определенной категории.
object
Количество запросов за текущий кредитный цикл только для продуктов с тарификацией по запросам. Продукты LaserStream с тарификацией по объему переданных данных (laserstreamGrpc, laserstreamWebsocket) здесь не отображаются — см. dataTransfer. Поля: rpc, enhancedApi, walletApi, das, webhooks, preConfirmations, archival, photon, other.
object
Количество байтов, переданных за текущий кредитный цикл, только для продуктов LaserStream с тарификацией по объему переданных данных. Эти продукты тарифицируются по объему переданных данных, а не по количеству запросов, поэтому они отображаются здесь и в credits, но никогда не отображаются в requests. Поля: laserstreamGrpc, laserstreamWebsocket.

Параметры запроса

string
обязательно
Идентификатор проекта, для которого нужно получить данные об использовании. Должен совпадать с проектом, связанным с API-ключом.

Авторизации

api-key
string
query
обязательно

Ключ API, переданный как параметр запроса.

Параметры пути

id
string<uuid>
обязательно

Идентификатор проекта, для которого необходимо получить данные об использовании. Должен соответствовать проекту, связанному с ключом API.

Пример:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Ответ

Данные об использовании проекта успешно получены.

creditsRemaining
number

Количество кредитов, оставшихся в текущем кредитном цикле. Рассчитывается как creditsLimit - regularCreditsUsed, но не может быть меньше 0.

Пример:

487500

creditsUsed
number

Общее количество кредитов, израсходованных в текущем кредитном цикле, включая обычные и предоплаченные кредиты.

Пример:

12500

prepaidCreditsRemaining
number

Количество оставшихся предоплаченных кредитов.

Пример:

50000

prepaidCreditsUsed
number

Количество предоплаченных кредитов, израсходованных в текущем кредитном цикле.

Пример:

0

creditCycle
object

Период, к которому относятся все значения кредитов в этом ответе, — период накопления и сброса кредитов, определяемый на основе опорной даты выставления счетов по подписке. Всегда присутствует для любого плана, включая бесплатные планы, по которым счета никогда не выставляются.

subscriptionDetails
object

Сведения о плане подписки проекта и цикле выставления счетов.

credits
object

Потребление кредитов по каждому продукту за текущий кредитный цикл, выраженное в целых кредитах. Охватывает все продукты. Необработанные значения накапливаются и округляются один раз в конце, чтобы соответствовать данным для выставления счетов, поэтому после округления сумма кредитов по продуктам может не совпадать в точности с creditsUsed.

requests
object

Количество запросов за текущий кредитный цикл только для продуктов с учетом по запросам. Продукты LaserStream с учетом по объему трафика (laserstreamGrpc, laserstreamWebsocket) здесь не отображаются — см. dataTransfer.

dataTransfer
object

Количество байтов, переданных за текущий кредитный цикл, только для продуктов LaserStream с учетом по объему трафика. Плата за эти продукты взимается на основе объема переданных данных, а не количества запросов, поэтому они отображаются здесь и в credits, но не в requests.