POST /api/v1/client-api/metrics/conversion/

Recuperar datos de conversión

Recupera datos de conversión para analizar las acciones de los usuarios y medir la efectividad de los esfuerzos de marketing a lo largo del tiempo.

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

from_periodstring | nullrequired

El estado de suscripción inicial del usuario en la conversión

to_periodstringrequired

El nuevo estado de suscripción del usuario tras la conversión

period_unitstring

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

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

date_typestring

Especifica qué fecha debe tratarse como fecha de incorporación del usuario

One of: "purchase_date", "profile_install_date"

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

Especifica el formato del archivo de exportación

One of: "json", "csv"

Responses

Datos de conversión recuperados correctamente

Schema

Respuesta que contiene datos de conversión que muestran la progresión de los usuarios entre estados de suscripción

dataarray of object

Array de puntos de datos de conversión (puede estar vacío para métricas agregadas)

valuenumber

El valor de la tasa de conversión

value_frominteger

Estado de suscripción inicial para la conversión

value_tointeger

Estado de suscripción objetivo para la conversión

compare_value_fromnumber

Valor inicial para el período de comparación

compare_value_tonumber

Valor final para el período de comparación

titlestring

Título de visualización que describe el tipo de conversión

typestring

Tipo de métrica de conversión

default_aggregationstring

Método de agregación predeterminado para esta métrica

descriptionstring

Explicación detallada de cómo se calcula la tasa de conversión

metric_namestring

Nombre interno de la métrica de conversión

is_jsonboolean

Indica si los datos están en formato JSON

unitstring

Unidad de medida (normalmente 'percent' para tasas de conversión)

recommended_periodobject

Rango de fechas recomendado para esta métrica de conversión

date_fromstring

Fecha de inicio del período recomendado

date_tostring

Fecha de fin del período recomendado

period_unitstring

Unidad de período recomendada

Example

{
  "data": [],
  "value": 0,
  "value_from": 0,
  "value_to": 0,
  "compare_value_from": null,
  "compare_value_to": null,
  "title": "Conversion rate from Paid to more than 6 months",
  "type": "multi",
  "default_aggregation": "sum",
  "description": "If Х - the number of the 1st payments taken during the selected date, and Y - the amount of the renewals that happened after the 6 months since the selected date from those 1st payments, then Conversion = (Y / X) * 100%. For example, we had 100 1st subscriptions of various products on the 1st of January and among them 20 renewed on the 1st week of July (the 25th payment). On the 8th of July, we open the chart and see the conversion of the 1st of January = (20 / 100) * 100% = 20%. Then 30 more subscribers of the 1st of January renewed by the start of August (the 8th payment). We open the chart on the 1st of August and see that the conversion of the 1st of January = ((20+30) / 100) * 100% = 50%. This number shows which part of those who had their 1st payment on the 1st of January converted to the period > 6 months with any number of payments by the current moment.",
  "metric_name": "from_paid_to_6_months_conversion",
  "is_json": true,
  "unit": "percent",
  "recommended_period": {
    "date_from": "2018-04-29",
    "date_to": "2024-12-31",
    "period_unit": "month"
  }
}

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.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ]
      },
      "from_period": 1,
      "to_period": "6+",
      "period_unit": "month",
      "date_type": "purchase_date",
      "segmentation": "country",
      "format": "json"
    })
data = response.json()