Registrar uso del producto

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

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

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.

Permissão pedida

contacts:write

Cabeçalho obrigatório

X-API-Key · chave secreta

Nível de acesso

Nível 3 · com revisão do suporte

Cabeçalhos

1 · todos opcionais

Idempotency-Keystring · opcional

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

Corpo (JSON)

9 · 1 obrigatórios

namestring · obrigatório

1–60 chars

labelstring · opcional

≤ 80 chars

propsobject · opcional

contactIdstring · opcional

externalIdstring · opcional

≤ 200 chars

emailstring · opcional

Ver os outros 3 parâmetros

companyIdstring · opcional

≤ 200 chars

actorLabelstring · opcional

≤ 120 chars

occurredAtstring · opcional

date-time

Resposta 200

SuccessFlag · 1 campos

dataLa operación se aceptó.

successbooleantrue

Erros possíveis

com a forma { "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