curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
API de conversiones
Enviar un evento de conversión
Registra un evento de conversión para un píxel de navegador de Profound
POST
/
v1
/
events
curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
Registra un evento de conversión para un píxel que pertenece a tu organización.
Los nombres de los campos y de los eventos son los mismos que los de los eventos del píxel del navegador. La API rechaza cualquier solicitud que contenga un campo que no reconozca. Una respuesta
Profound establece los siguientes campos por su cuenta. Se rechaza cualquier solicitud que contenga alguno de ellos:
202 significa que Profound puso el evento en cola. Cualquier otro estado significa que Profound no lo registró.
Autorizaciones
string
requerido
Encabezado de autenticación Bearer con el formato
Bearer <your key>. La clave empieza por pfck_. Para saber cómo generar tu clave, consulta Primeros pasos con la Conversions API.Campos de la solicitud
string
requerido
Un UUID que generas tú. Reutiliza el mismo valor en cada reintento de la misma conversión.
string
requerido
Hasta 128 caracteres. Debe pertenecer a tu organización.
string
requerido
Hasta 128 caracteres. Consulta la referencia de eventos.
string
requerido
standard o custom. Profound lo deduce a partir de event_name: el nombre de un evento estándar es standard; cualquier otro es custom. Si no coinciden, se rechaza.integer
requerido
Cuándo se produjo la conversión, en milisegundos Unix. Consulta Hora del evento.
object
requerido
storage, send y share_ads, todos booleanos. send es obligatorio y debe ser true. Los otros dos tienen el valor false de forma predeterminada. Consulta Consentimiento y datos personales.object
Hasta 32 entradas de hasta 2048 caracteres cada una, con el nombre del ID de clic como clave, por ejemplo
oppref. Consulta Atribución.string
Hasta 256 caracteres. Envíalo junto con
utm_pf_ad_provider.string
Hasta 128 caracteres.
openai es el único proveedor que Profound usa actualmente.string
Hasta 128 caracteres; no puede estar vacío. Tu ID de pedido o de transacción. Consulta Deduplicación.
string
Hasta 128 caracteres. El ID de visitante que almacenó el píxel del navegador.
object
external_user_id y external_account_id, de hasta 256 caracteres cada uno. Solo ID opacos.object
first y last: el canal de adquisición que registró el píxel del navegador.object
url, referrer y title, de hasta 2048 caracteres cada uno. Envía los tres cuando envíes page.object
Hasta 128 entradas. La carga útil del evento, como
amount y currency. Consulta Conjuntos de campos.string
De dónde procede el estado del consentimiento, por ejemplo
onetrust, tcf o explicit. Un valor no reconocido se almacena como unknown.integer
Solo se acepta
1, que es el valor predeterminado.ingest_id, ts_server, ip_address, origin, query_params, user_agent, channel, org_id.
Hora del evento
ts_client es el momento en que se produjo la conversión, no el momento en que envías el evento. Debe estar dentro de los últimos siete días y no más de cinco minutos en el futuro. Los eventos con más de una semana de antigüedad se rechazan en lugar de registrarse con una fecha incorrecta.
Respuesta
string
queued.string
El
event_id que enviaste.Atribución
Los campos de atribución no son obligatorios, pero una solicitud sin ellos no se atribuye a ningún anuncio. El píxel del navegador almacena los valores de atribución en cookies propias de tu dominio, por lo que solo una solicitud procedente del navegador del visitante los incluye. Si la conversión se confirma más tarde mediante una solicitud que no procede del navegador, como un webhook de pago, lee las cookies de una solicitud anterior del navegador (por ejemplo, en el checkout), guárdalas con el pedido y cópialas en el evento cuando lo envíes:| Enviar | Leer de la cookie | Contenido de la cookie | Duración |
|---|---|---|---|
click_ids | _pf_clk | JSON codificado como URL, con el nombre del ID de clic como clave: oppref, utm_adid, gclid | 90 días |
utm_pf_ad_id y utm_pf_ad_provider | _pf_id | JSON codificado como URL. El ID del anuncio está en ai y su proveedor, en ap | 365 días |
Consejos
- Envía los ID de clic en
click_ids. Si una plataforma publicitaria añadió un ID de clic a tu URL de destino, comoopprefde OpenAI, envíalo enclick_idspara que la conversión pueda atribuirse a ese anuncio. - Envía juntos los dos valores del anuncio. Profound acepta
utm_pf_ad_idsinutm_pf_ad_provider, pero en ese caso no puede atribuir la conversión a un anuncio. Envía ambos o ninguno. Para los anuncios de OpenAI, el valor del proveedor esopenai. - Ambas cookies necesitan consentimiento de almacenamiento. Si el visitante rechazó el almacenamiento, el píxel del navegador no las escribió, así que no hay nada que enviar.
Deduplicación
- La misma conversión enviada más de una vez: Profound cuenta como uno solo dos eventos con el mismo
event_idpara el mismo píxel. Reutiliza el ID cuando reintentes una solicitud y genera uno nuevo solo para una conversión nueva. Profound elimina los eventos duplicados poco después de que lleguen. - El mismo pedido desde el píxel del navegador y desde esta API: si el píxel del navegador también envía un evento para el pedido, envía la misma
dedup_key(tu ID de pedido) en ambos eventos. Profound la almacena en los dos para poder emparejarlos.
Consentimiento y datos personales
consent.send debe ser true; de lo contrario, Profound rechaza el evento. consent.share_ads es un permiso independiente para compartir con una plataforma publicitaria y no está implícito en send. Transmite el estado de consentimiento que registró tu herramienta de consentimiento en el momento de la conversión. Consulta Consentimiento y privacidad para saber qué controla cada permiso.
Nunca incluyas una dirección de correo electrónico, un nombre u otro identificador personal en un evento. Profound depura props y page y conserva el evento. En cualquier otro campo, como click_ids, identity, dedup_key o event_name, un identificador detectado hace que se rechace toda la solicitud. En dedup_key, identity y los valores del anuncio solo se buscan direcciones de correo electrónico, números de tarjeta y números de la seguridad social, por lo que un ID de pedido compuesto por dígitos con formato es seguro. Todos los demás campos también rechazan valores que parezcan números de teléfono.
Profound no deduce nada de la conexión: ni dirección IP, ni ubicación geográfica, ni user agent. La dirección que llama a este endpoint es tu servidor, no un visitante.
curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
¿Esta página le ayudó?