Referencia (endpoints)Formularios

Ver las métricas de un formulario

Sirve para medir un formulario: cuántos se enviaron, cuántos se abrieron y cuántos se completaron, con sus porcentajes.

GET
/forms/families/{familyId}/metrics

Permiso requerido: Contactos y conversaciones → Ver

Devuelve los números de un formulario de tu cuenta: cuántos se enviaron, cuántos se abrieron y cuántos se completaron, y sus porcentajes. {familyId} es el family_id del formulario. Acepta los mismos filtros de fecha, versión y origen que la lista de respuestas; un filtro inválido responde 422. Responde 404 si el formulario no existe o no es de tu cuenta.

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de la ruta

familyId*string

Id opaco: un texto que empieza con frm_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^frm_[A-Za-z0-9]{23}$

Parámetros de consulta

from?|
Formatodate-time
to?|
Formatodate-time
version_id?|

Id opaco: un texto que empieza con frv_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^frv_[A-Za-z0-9]{23}$
origin?|
Largolength <= 24
status?|
Largolength <= 24
kind?|
Largolength <= 24
effect_status?|
Largolength <= 24
search?|
Largolength <= 191
per_page?|
Rango1 <= value
page?|
Rango1 <= value

Cuerpo de la respuesta

OK

application/json
  1. response
data*
curl -X GET "https://example.com/forms/families/frm_AyJUGabeXUAk9dbBuWegw4B/metrics"
{  "data": {    "not_sent": 0,    "not_sent_reasons": [      {        "reason": "string",        "label": "string",        "count": 0      }    ],    "sent": 0,    "delivered": 0,    "read": 0,    "completed": 0,    "pending": 0,    "unfinished": 0,    "partial": 0,    "completion_rate": 0,    "delivery_rate": 0,    "read_rate": 0,    "median_seconds_to_complete": 0  }}

Esto es lo que se copia para tu IA

Cargando…