Registrar uso del producto

POSThttps://api.bydomu.com/v1/usage/events

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Un evento de uso de tu producto (una función que se usó, un límite que se alcanzó, etc.), del mismo tipo que Domu('track', …) en el widget. Identifica a quién pertenece con contactId, externalId (el id de tu usuario en tu sistema) o email. Se agrega por contacto y por día para la ficha y el riesgo de cancelación; el detalle se retiene un tiempo acotado. Responde 200 aunque no encuentre el contacto.

Permission required

contacts:write

Required header

X-API-Key · secret key

Access level

Level 3 · with support review

Headers

1 · all optional

Idempotency-Keystring · optional

Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas.8–128 chars

Body (JSON)

9 · 1 required

namestring · required

1–60 chars

labelstring · optional

≤ 80 chars

propsobject · optional

contactIdstring · optional

externalIdstring · optional

≤ 200 chars

emailstring · optional

See the other 3 parameters

companyIdstring · optional

≤ 200 chars

actorLabelstring · optional

≤ 120 chars

occurredAtstring · optional

date-time

Response 200

SuccessFlag · 1 fields

dataLa operación se aceptó.

successbooleantrue

Possible errors

shaped as { "error": { "code", "message" } }

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED
402PAYMENT_REQUIRED
403FORBIDDEN
409DUPLICATE
429RATE_LIMITED
500INTERNAL_ERROR