Zum Hauptinhalt springen

API: Commitments

Stefan Schindler avatar
Verfasst von Stefan Schindler
Vor über 4 Jahren aktualisiert

Mit diesem API-Call kann die Anzahl aller Eintragungen auf einer Commitment-Seite ausgelesen werden. Folgende GET-Parameter werden unterstützt:

Parameter

Default

Beschreibung

page_size

20

Die Anzahl der Personen, die geholt werden sollen (max. 20)

page_number

0

Die Seite, die geholt werden soll

media_content

0

1: Es werden nur Einträge mit Foto zurückgegeben

has_message

0

1: Es werden nur Einträge mit Statement zurückgegeben

counter_only

0

1: Es werden keine Einträge, sondern nur die Gesamtzahl aller Personen zurückgegeben

use_cache

false

true: aus Performancegründen sollte bei Einbettungen in Seiten dieser Paramter angegeben werden. Cachedauer der Rückgabe ist 15 Minuten

Hier ein Beispiel-Request:

HTTP-GET: <cambuildr-url>/api/v1/pages/{page_id}/commitments?counter_only=1

Die ID der Commitment-Seite kann ganz einfach in der Administration ausgelesen werden:

Hat dies deine Frage beantwortet?