English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/funnel/

Recuperar datos del embudo

Copy as Markdown

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

Límite de velocidad: 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

ID de producto cualificado por store, con el formato <store>:<product_id> — por ejemplo app_store:premium_monthly o play_store:premium_sub:monthly-base-plan para una suscripción de Google con un plan base. Se rechaza un ID de producto sin prefijo de 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 que se rastrean para medir su 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

placement_idarray of string

IDs internos de Adapty de los placements para los que se recuperarán datos — el UUID que aparece en la URL del placement en el dashboard, no el ID de placement que se pasa al SDK

audience_idarray of string

IDs internos de Adapty de las audiencias de placement para las que se recuperarán datos

paywall_idarray of string

IDs internos de Adapty de los paywalls para los que se recuperarán datos — el UUID que aparece en la URL del paywall en el dashboard

flow_idarray of string

IDs internos de Adapty de los flows para los que se recuperarán datos — el UUID que aparece en la URL del flow en el dashboard

flow_screen_idarray of string

Pantallas de flow para las que se recuperarán datos, cada una con el formato <flow_id>:<screen_id> — por ejemplo 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

IDs internos de Adapty de los segmentos para los que se recuperarán datos

show_value_asstring

Especificar cómo se muestran los valores

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

segmentationstring

Divide los datos en una serie por cada valor de esta dimensión. Por ejemplo, flow_id devuelve una serie separada para cada flow, y placement_id para cada placement.

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

formatstring

Especificar el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos del embudo recuperados correctamente

Schema

Respuesta que contiene datos de análisis de embudo que muestra la progresión de 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 del embudo que muestra 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 en relación con la primera etapa

relative_changesnumber

Cambio en la tasa de conversión en comparación con el 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 la cancelación en esta etapa

churn_reasonsarray of object

Array de motivos específicos de cancelación

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 velocidad superado. Máximo 2 solicitudes por segundo por aplicación, compartido por todas las claves API de la aplicación.