Pobierz statystyki kont zarządzanych
Pobierz liczbę zarządzanych kont, aktywnych agentów i zadań druku w miesiącu kalendarzowym UTC.
Działanie metody
Pobierz liczbę zarządzanych kont, aktywnych agentów i zadań druku w miesiącu kalendarzowym UTC.
Uwierzytelnianie
Przekaż jednorazowe potwierdzenie JWT Developer Application podpisane algorytmem RS256 w Authorization: Bearer <application_assertion>. Nie jest to token dostępu do Public API.
Żądanie
Podstawowy adres API: https://public-api.cloudprint.me/partner-api/v1/usage
Parametry
| Nazwa | Położenie | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|---|
period | query | string | nie | Miesiąc kalendarzowy UTC w formacie YYYY-MM, którego dotyczy raport użycia. | example: "2026-08" |
X-Request-Id | header | string | nie | Opcjonalny identyfikator do śledzenia żądania; CloudPrint zwróci bezpieczną wartość w nagłówku odpowiedzi. | maxLength: 128; example: "order-100045-attempt-1" |
Treść żądania
Metoda nie ma treści żądania.
Przykładowe żądania
cURL
bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Odpowiedź
Status HTTP: 200 — Żądanie zostało wykonane.
Pola odpowiedzi
| Nazwa | Typ | Wymagane | Opis | Ograniczenia |
|---|---|---|---|---|
period | string | tak | Miesiąc kalendarzowy UTC w formacie YYYY-MM, którego dotyczy raport użycia. | — |
starts_at | string (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
ends_at | string (date-time) | tak | Znacznik czasu CloudPrint w formacie ISO 8601. | — |
managed_accounts | integer | tak | Liczba zarządzanych kont klientów uwzględnionych w okresie rozliczeniowym. | min: 0 |
active_agents | integer | tak | Liczba aktywnych agentów w wybranym miesiącu kalendarzowym UTC. | min: 0 |
print_jobs | integer | tak | Zadania druku zwrócone dla bieżącego konta i filtrów. | min: 0 |
Przykładowa odpowiedź
json
{
"period": "2026-08",
"starts_at": "2026-08-06T12:00:00Z",
"ends_at": "2026-08-06T12:00:00Z",
"managed_accounts": 0,
"active_agents": 0,
"print_jobs": 0
}Błędy
| Status HTTP | Opis |
|---|---|
401 | Brak uwierzytelnienia albo jest ono nieprawidłowe. |
403 | Brak uprawnień wymaganych do tej operacji. |
422 | Pola żądania nie przeszły walidacji. |
429 | Przekroczono limit żądań; zastosuj Retry-After. |
500 | Wewnętrzny błąd CloudPrint. |
Powiązana dokumentacja
Tworzenie i zarządzanie kontami klientówUwierzytelniaj żądania Partner API, twórz konta zarządzane oraz wstrzymuj, wznawiaj lub zamykaj je w razie potrzeby.Pobierz zarządzane konta klientówPobierz konta klientów utworzone przez uwierzytelnioną Developer Application wraz ze stanem agentów i drukarek.Błędy i ponowienia CloudPrint APIObsługuj statusy HTTP, błędy maszynowe, limity, identyfikatory żądań i bezpieczne ponowienia.