POST /api/v1/client-api/metrics/funnel/

Recuperar datos de embudo

Copy as Markdown

Recupera datos de embudo para realizar el seguimiento de la progresión de los usuarios a través de etapas específicas de un proceso de conversión.

Límite de tasa: 2 solicitudes por segundo.

Request body

filtersobjectrequired
datearray of stringrequired

Introduce la fecha o el período de tiempo para el que deseas recuperar los datos del gráfico

compare_datearray of string

Introduce la fecha o el período de tiempo de comparación

storearray of string

Filtra por el store donde se realizó la compra

countryarray of string

Filtra por el código de país de 2 letras donde se realizó la compra

store_product_idarray of string

Identificador único de un producto del store

durationarray of string

Especifica la duración de la suscripción

attribution_sourcearray of string

La integración de origen para la atribución

attribution_statusarray of string

Indica si la atribución es orgánica o no orgánica

attribution_channelarray of string

Canal de marketing que originó la transacción

attribution_campaignarray of string

Campaña de marketing que originó la transacción

attribution_adgrouparray of string

Grupo de anuncios de atribución que originó la transacción

attribution_adsetarray of string

Conjunto de anuncios de atribución que originó la transacción

attribution_creativearray of string

Elementos visuales o de texto específicos de un anuncio o campaña rastreados para medir la efectividad

offer_categoryarray of string

Especifica las categorías de oferta para las que deseas recuperar datos

offer_typearray of string

Especifica los tipos de oferta para los que deseas recuperar datos

offer_idarray of string

Especifica las ofertas concretas para las que deseas recuperar datos

period_unitstring

Especifica el intervalo de tiempo para agregar los datos de analíticas

One of: "day", "week", "month", "quarter", "year"

show_value_asstring

Especifica cómo se muestran los valores

One of: "absolute", "relative", "both"

segmentationstring

Define la base para la segmentación

formatstring

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de embudo recuperados correctamente

Schema

Respuesta que contiene datos de análisis de embudo que muestran la progresión de los usuarios a través de las etapas de conversión

dataarray of object

Array de segmentos de embudo que muestran las diferentes etapas del proceso de conversión

titlestring

Título de visualización para este segmento de embudo

typestring

Tipo de segmento de embudo ('total' para datos agregados)

valuesarray of object

Array de valores de embudo que muestran la progresión a través de las etapas

periodinteger

Número de período en el embudo (-2 = Instalación, -1 = Paywall mostrado, etc.)

titlestring

Título de visualización para esta etapa del embudo

valueinteger

Número de usuarios que alcanzaron esta etapa

value_relativenumber

Porcentaje de usuarios que alcanzaron esta etapa relativo a la primera etapa

relative_changesnumber

Cambio en la tasa de conversión respecto al período anterior

following_changesobject

Información sobre los usuarios que abandonaron después de esta etapa

titlestring

Título para la etapa de abandono

valueinteger

Número de usuarios que abandonaron

value_relativenumber

Porcentaje de usuarios que abandonaron

churn_reason_titlestring

Título que describe el motivo de abandono en esta etapa

churn_reasonsarray of object

Array de motivos de abandono específicos

valuesarray of object

Valores anidados adicionales para esta etapa del embudo

Example 
{
  "data": [
    {
      "title": "Total",
      "type": "total",
      "values": [
        {
          "period": -2,
          "title": "Install",
          "value": 2,
          "value_relative": 100,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 2,
            "value_relative": 100
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        },
        {
          "period": -1,
          "title": "Paywall displayed",
          "value": 0,
          "value_relative": 0,
          "relative_changes": 0,
          "following_changes": {
            "title": "Drop off",
            "value": 0,
            "value_relative": 0
          },
          "churn_reason_title": "",
          "churn_reasons": [],
          "values": []
        }
      ]
    }
  ]
}

Solicitud incorrecta

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

No autorizado

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

Límite de tasa superado. Máximo 2 solicitudes por segundo por clave de API.