API-Referenz / Audit

Audit

Die Endpoints der Gruppe Audit der Voiceland AI API, mit Parametern, Schemata und Beispielen mit curl.

Zuletzt aktualisiert:

Die Beschreibungen der Endpoints und der Felder erscheinen auf Englisch, genau so, wie die API sie ausliefert. Das ist Absicht: Sie lesen hier, was Sie auch in den Antworten sehen.

GET /v1/audit#

List audit events. Your tenant-scoped audit trail, newest first.

Parameter

Name Ort Typ Erforderlich Beschreibung
from query string Window start (RFC3339).
to query string Window end (RFC3339).
limit query integer Max rows.
cursor query string Pagination cursor.

Antworten

Code Beschreibung
200 Success.
401 Missing or invalid API key.
402 Your plan does not include audit log export (feature_not_entitled), or the account has no subscription (no_subscription).
4XX Request error (validation, not-found, etc.).
5XX Server or upstream error.

Beispielanfrage

curl "https://api.voiceland.ai/v1/audit" \
  -H "Authorization: Bearer VL_API_KEY"

Beispielantwort

{
  "items": []
}

GET /v1/audit/{id}#

Get an audit event. Returns one audit event by id.

Parameter

Name Ort Typ Erforderlich Beschreibung
id path string Ja Audit event id.

Antworten

Code Beschreibung
200 Success.
401 Missing or invalid API key.
402 Your plan does not include audit log export (feature_not_entitled), or the account has no subscription (no_subscription).
4XX Request error (validation, not-found, etc.).
5XX Server or upstream error.

Beispielanfrage

curl "https://api.voiceland.ai/v1/audit/{id}" \
  -H "Authorization: Bearer VL_API_KEY"

Schemata#

Error#

Error envelope returned for non-2xx responses.

Feld Typ Erforderlich Beschreibung
error object Ja

Die Konsole

Diese Seiten sind schreibgeschützt. Der Testanruf, die API-Schlüssel und die aktuelle API-Referenz finden Sie in der Konsole, in der Ihr Konto angemeldet ist.

Konsole öffnen