Registrar evento de analítica del portal

POSThttps://api.bydomu.com/v1/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.

Registra una vista, búsqueda o clic del portal para su analítica. Se procesa en segundo plano: la respuesta es inmediata y no confirma que el evento se haya guardado. Responde 200, no 201.

Permissão

events:write

Chaves

Publicável ou secreta

Cabeçalhos

X-API-Keystringobrigatório

Sua chave publicável ou secreta.

Idempotency-Keystring

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)

typestringobrigatório

PAGE_VIEWPROPERTY_VIEWSEARCHLEAD_FORMWHATSAPP_CLICKCALL_CLICKSCHEDULE_CLICKSHARE_CLICKFINDER_SUBMIT

propertyIdstring

searchQuerystring

≤ 200 chars

referrerstring

≤ 500 chars

metadataobject

Respostas

200Evento aceptado

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

402PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

409DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

curl -X POST "https://api.bydomu.com/v1/events" \ -H "X-API-Key: $BYDOMU_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "type": "PROPERTY_VIEW", "propertyId": "clx1prop001", "referrer": "https://google.com" }'

const res = await fetch("https://api.bydomu.com/v1/events", { method: "POST", headers: { "X-API-Key": process.env.BYDOMU_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ "type": "PROPERTY_VIEW", "propertyId": "clx1prop001", "referrer": "https://google.com" }), }); const data = await res.json();

import os, requests r = requests.post( "https://api.bydomu.com/v1/events", headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}, json={ "type": "PROPERTY_VIEW", "propertyId": "clx1prop001", "referrer": "https://google.com" } ) data = r.json()