API Reference — Events Ingestion
API Reference — Meters Creation
Creating a Meter
Meters define how your usage events are aggregated and measured for billing purposes. Before creating a meter, plan your usage tracking strategy:- Identify what usage events you want to track
- Determine how events should be aggregated (count, sum, etc.)
- Define any filtering requirements for specific use cases
Step-by-Step Meter Creation
Befolgen Sie diesen Leitfaden, um Ihr Nutzungs-Messgerät einzurichten:Configure Basic Information
Configure Aggregation Settings
- Count
- Sum
- Max
- Last
Configure Event Filtering (Optional)
- AND Logic
- OR Logic
user_tier = "premium" AND endpoint = "/api/v2/users"Add Condition
Configure Property Key
Select Comparator
equals— Exakte Übereinstimmungnot_equals— Ausschlussfiltergreater_than— Numerischer Vergleichgreater_than_or_equals— Numerischer Vergleich (einschließlich)less_than— Numerischer Vergleichless_than_or_equals— Numerischer Vergleich (einschließlich)contains— Teilzeichenfolge in String enthaltendoes_not_contain— String-Ausschlussfilter
Set Comparison Value
Add Groups
Create Meter
Messgerät mit einem Produkt verknüpfen
Nachdem Sie Ihr Messgerät erstellt haben, müssen Sie es mit einem Produkt verknüpfen, um eine verbrauchsbasierte Abrechnung zu aktivieren. Dadurch werden die Nutzungsdaten Ihres Messgeräts mit Preisregeln für die Kundenabrechnung verbunden. Durch die Verknüpfung von Messgeräten mit Produkten wird die Verbindung zwischen Nutzungserfassung und Abrechnung hergestellt:- Produkte definieren Preisregeln und Abrechnungsverhalten
- Messgeräte liefern Nutzungsdaten für Abrechnungsberechnungen
- Mehrere Messgeräte können für komplexe Abrechnungsszenarien mit einem einzelnen Produkt verknüpft werden
Prozess der Produktkonfiguration
Wandeln Sie Ihre Nutzungsdaten in abrechenbare Gebühren um, indem Sie Ihre Produkteinstellungen korrekt konfigurieren:Choose Usage-Based Billing Product Type
Select Associated Meter
Add Your Meter
- Klicken Sie auf Add Meters, um verfügbare Messgeräte anzuzeigen
- Wählen Sie das von Ihnen erstellte Messgerät aus der Dropdown-Liste aus
- Das ausgewählte Messgerät wird in Ihrer Produktkonfiguration angezeigt
Configure Price Per Unit
- 1,000 verbrauchte Einheiten = 1,000 × $0.50 = $500.00 berechnet
- 500 verbrauchte Einheiten = 500 × $0.50 = $250.00 berechnet
- 100 verbrauchte Einheiten = 100 × $0.50 = $50.00 berechnet
Set Free Threshold (Optional)
- Kostenlose Schwelle: 100 Einheiten
- Preis pro Einheit: $0.50
- Kundennutzung: 250 Einheiten
- Berechnung: (250 - 100) × $0.50 = $75.00 berechnet
Save Configuration
- An Ihr Messgerät gesendete Nutzungsereignisse werden erfasst und aggregiert
- Abrechnungsberechnungen wenden Ihre Preisregeln automatisch an
- Kunden werden basierend auf ihrem tatsächlichen Verbrauch während jedes Abrechnungszeitraums belastet
Nutzungsereignisse senden
Nachdem Ihr Messgerät konfiguriert wurde, können Sie beginnen, Nutzungsereignisse aus Ihrer Anwendung zu senden, um die Kundennutzung zu erfassen.Ereignisstruktur
Jedes Nutzungsereignis muss die folgenden erforderlichen Felder enthalten:Beispiele für die Usage Events API
Senden Sie Nutzungsereignisse über die Events API an Ihre konfigurierten Messgeräte:Wichtige Hinweise für eine zuverlässige Erfassung
Befolgen Sie diese Vorgehensweisen, um eine genaue und robuste Nutzungserfassung in der Produktion sicherzustellen.timestamp bei Echtzeitereignissen weg; dann wird standardmäßig der aktuelle UTC-Zeitstempel verwendet. Setzen Sie ihn bei verzögerten oder stapelweise gesendeten Ereignissen explizit im ISO-8601-Format, damit die Nutzung dem korrekten Abrechnungszeitraum zugeordnet wird. Beachten Sie, dass das zulässige Zeitfenster eng ist: Ereignisse mit einem Zeitstempel von mehr als 1 Stunde in der Vergangenheit oder mehr als 5 Minuten in der Zukunft werden abgelehnt. Eine historische Nachverarbeitung wird nicht unterstützt — leeren Sie gepufferte Ereignisse innerhalb einer Stunde.Analysen der verbrauchsbasierten Abrechnung
Überwachen und analysieren Sie Ihre Daten zur verbrauchsbasierten Abrechnung mit einem umfassenden Analyse-Dashboard. Verfolgen Sie Verbrauchsmuster von Kunden, die Leistung von Messgeräten und Abrechnungstrends, um Ihre Preisstrategie zu optimieren und Nutzungsverhalten zu verstehen.Übersichtsanalysen
Der Tab „Overview“ bietet eine umfassende Ansicht Ihrer Leistung bei der verbrauchsbasierten Abrechnung:Aktivitätsmetriken
Verfolgen Sie wichtige Nutzungsstatistiken über verschiedene Zeiträume hinweg:Diagramm der Messgerätemengen

- Zeitreihenvisualisierung: Verfolgen Sie Nutzungsmuster über Tage, Wochen oder Monate
- Unterstützung mehrerer Messgeräte: Zeigen Sie Daten verschiedener Messgeräte gleichzeitig an
- Trendanalyse: Erkennen Sie Nutzungsspitzen, Muster und Wachstumskurven
Ereignisanalysen

Anzeige von Ereignisinformationen
Die Ereignistabelle bietet mit den folgenden Spalten eine klare Übersicht über einzelne Nutzungsereignisse:- Ereignisname: Die spezifische Aktion oder der Auslöser, durch die bzw. den das Nutzungsereignis erzeugt wurde
- Ereignis-ID: Eine eindeutige Kennung für jede Ereignisinstanz
- Kunden-ID: Der mit dem Ereignis verbundene Kunde
- Zeitstempel: Der Zeitpunkt, zu dem das Ereignis aufgetreten ist
Kundenanalysen
Der Tab „Customers“ bietet eine detaillierte Tabellenansicht der Kundennutzungsdaten mit den folgenden Informationen:Verfügbare Datenspalten
Tabellenfunktionen
- Spaltenfilterung: Verwenden Sie die Funktion „Edit Columns“, um bestimmte Datenspalten ein- oder auszublenden
- Echtzeitaktualisierungen: Die Nutzungsdaten spiegeln die aktuellsten Verbrauchsmetriken wider
Aggregationsbeispiele
Hier finden Sie praktische Beispiele dafür, wie verschiedene Aggregationstypen funktionieren:Aggregationstypen verstehen
Verschiedene Aggregationstypen eignen sich für unterschiedliche Abrechnungsszenarien. Wählen Sie den passenden Typ basierend darauf, wie Sie die Nutzung messen und abrechnen möchten.Beispiele für die praktische Implementierung
Diese Beispiele zeigen reale Anwendungen jedes Aggregationstyps mit Beispielereignissen und erwarteten Ergebnissen:Count Aggregation — API Calls
Count Aggregation — API Calls
- Ereignisname:
api.call - Aggregationstyp: Count
- Maßeinheit:
calls
Sum Aggregation — Data Transfer
Sum Aggregation — Data Transfer
- Ereignisname:
data.transfer - Aggregationstyp: Sum
- Over Property:
bytes - Maßeinheit:
GB
Max Aggregation — Peak Concurrent Users
Max Aggregation — Peak Concurrent Users
- Ereignisname:
concurrent.users - Aggregationstyp: Max
- Over Property:
count - Maßeinheit:
users
Beispiele für die Ereignisfilterung
- Filter by API Endpoint
- Filter by Value Range
- Complex Multi-Condition Filters
- Eigenschaft:
endpoint - Vergleichsoperator:
equals - Wert:
/v1/orders
Fehlerbehebung
Beheben Sie häufige Probleme bei der Implementierung der verbrauchsabhängigen Abrechnung und stellen Sie eine genaue Erfassung und Abrechnung sicher.Häufige Probleme
Die meisten Probleme bei der verbrauchsabhängigen Abrechnung lassen sich diesen Kategorien zuordnen:- Probleme bei der Übermittlung und Verarbeitung von Ereignissen
- Probleme bei der Messgerätekonfiguration
- Fehler bei Datentypen und Formatierung
- Probleme mit Kunden-ID und Authentifizierung
Schritte zur Fehlerbehebung
Bei der Fehlerbehebung der verbrauchsabhängigen Abrechnung:- Überprüfen Sie die Ereignisübermittlung im Tab „Events“ der Analysen
- Stellen Sie sicher, dass die Messgerätekonfiguration Ihrer Ereignisstruktur entspricht
- Validieren Sie Kunden-IDs und API-Authentifizierung
- Überprüfen Sie Filterbedingungen und Aggregationseinstellungen
Lösungen und Korrekturen
Events not showing in meter
Events not showing in meter
- Der Ereignisname stimmt nicht exakt mit der Messgerätekonfiguration überein
- Filterbedingungen für Ereignisse schließen Ihre Ereignisse aus
- Die Kunden-ID ist in Ihrem Dodo Payments-Konto nicht vorhanden
- Der Ereigniszeitstempel liegt außerhalb des aktuellen Abrechnungszeitraums
- Überprüfen Sie Schreibweise und Groß-/Kleinschreibung des Ereignisnamens
- Überprüfen und testen Sie Ihre Filterbedingungen
- Bestätigen Sie, dass die Kunden-ID gültig und aktiv ist
- Stellen Sie sicher, dass die Ereigniszeitstempel aktuell und korrekt formatiert sind
Aggregation not working as expected
Aggregation not working as expected
- Der Name der Over Property entspricht nicht den Metadatenschlüsseln des Ereignisses
- Metadatenwerte haben den falschen Datentyp (String statt Zahl)
- Erforderliche Metadateneigenschaften fehlen
- Stellen Sie sicher, dass die Metadatenschlüssel exakt Ihrer Einstellung für Over Property entsprechen
- Konvertieren Sie String-Zahlen in Ihren Ereignissen in tatsächliche Zahlen
- Fügen Sie alle erforderlichen Eigenschaften in jedes Ereignis ein
Filtering not working
Filtering not working
- Namen der Filtereigenschaften stimmen nicht mit den Ereignismetadaten überein
- Falscher Vergleichsoperator für den Datentyp (String statt Zahl)
- Groß-/Kleinschreibung bei Stringvergleichen
- Überprüfen Sie genau, ob die Eigenschaftsnamen übereinstimmen
- Verwenden Sie geeignete Vergleichsoperatoren für Ihre Datentypen
- Berücksichtigen Sie beim Filtern von Strings die Groß-/Kleinschreibung