Remerge es una plataforma de retargeting de aplicaciones. Además de nuestro panel de control y de nuestras capacidades analíticas, los clientes pueden obtener informes basados en JSON de la API de informes de Remerge de sus campañas activas para su internal Business Intelligence (BI) diariamente.
General
Ten en cuenta lo siguiente:
-
SOLO se puede acceder a la API de informes de Remerge a través de la Terminal (o mediante una API) de la siguiente manera:
- Terminal: Esta opción requiere que se use la herramienta de transferencia de datos Curl, conforme a los ejemplos de Solicitud de inicio de sesión (tu gerente de cuenta de Remerge debería brindarte las credenciales) y de Solicitud POST que figuran a continuación.
-
API: Los clientes pueden emplear su API interna y sus herramientas de transferencia de datos.
- NO se puede acceder a la API de informes de Remerge desde un navegador web.
- Remerge almacena tus datos SOLO durante un período limitado de seis meses. Por lo tanto, para mitigar una posible situación en la que desees obtener datos anteriores a dicho período, te recomendamos que lleves tu propio registro de datos.
Dimensiones
El rendimiento del cliente se desglosa en seis dimensiones: marca horaria, país, aplicaciones, campaña, tipo de campaña y anuncios relacionados. Por lo tanto, los resultados se pueden importar con facilidad, dividir en partes más pequeñas y distribuirse de conformidad con las dimensiones provistas a cualquier plataforma de inteligencia empresarial que elija el cliente. Consulta la sección Índice abajo para obtener más detalles sobre parámetros y campos específicos.
Endoint
Se puede acceder a la API mediante el siguiente endpoint:
https://api.remerge.io/reportSolicitud y respuesta
Parámetros de solicitud
La API de informes de Remerge provee una interfaz simple para consultar los datos. Los únicos parámetros requeridos son la fecha de inicio y de finalización.
Ten en cuenta lo siguiente: Para obtener los datos de ayer, debes asegurarte de seleccionar la fecha de hoy como tu end_date, por ejemplo, para recibir los datos del 2021-12-08, establece 2021-12-08 como tu start_date y 2021-12-09 como tu end_date.
| Nombre | Contenido | Ejemplos | Obligatorio |
|---|---|---|---|
| *start_date | Fecha de inicio del informe (AAAA-MM-DD) | 2021-12-08 | x |
| *end_date | Fecha de finalización del informe (AAAA-MM-DD) | 2021-12-09 | x |
| dimensions |
Una lista de las dimensiones separadas por comas que desglosa los agregados por defecto para audiencia, país, campaña, tipo de campaña y anuncio si no se pasa. Dimensiones posibles: audiencia, país, campaña, tipo de campaña, anuncio, etiqueta de anuncio o plataforma. |
country, platform | |
| Filter (Filtro) |
Es posible filtrar la solicitud por tipo de campaña, por ejemplo, https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&campaign_type=retargeting |
Retargeting |
Una solicitud válida se debería ver de la siguiente manera: https://api.remerge.io/report?start_date=2017-01-10&end_date=2017-01-11&dimensions=campaign,ad
Nota:
- Te recomendamos utilizar un programa de edición de texto (tal como Sublime o Atom) para garantizar que se transfieran a la terminal todos los símbolos de tu consulta de manera correcta.
- A menos que limites las dimensiones en tu URL de solicitud, la respuesta generará todas las dimensiones potenciales.
Autorización
Ejemplo
Solicitud de inicio de sesión
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -X POST
-d '{"user" : { "email" : "your@email.com", "password": "password"}}' https://api.remerge.io/users/sign_in
Devolución del token requerido como JSON
{"email":"your@email.com","token":"J-QeJxyza7JH19QUDb4","user_id":1234,"user_name":"Peter Example","user_token":"J-QeJ49Yasdf219QUDb4"}
Encabezados obligatorios de la solicitud para una solicitud de informe válida
| Nombre | Contenido | Ejemplo | Obligatorio |
|---|---|---|---|
| Request Header | Tipo de contenido | 'Content-Type: application/json' | x |
| Request Header | Aceptación | 'Accept: application/json' | x |
| Request Header | Token de autorización | 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"' | x |
| Request Type | POST | POST | x |
Solicitud de ejemplo
A continuación hay un ejemplo de una solicitud POST para la API de informes de Remerge que usa la herramienta de transferencia de datos curl:
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Token user_token="xxXxxXXXXXXx-xXxxXXX", email="example@mydomain.com"' -X POST "https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&dimensions=audience%2Ccountry%2Ccampaign%2Cad%2Cad_label%2Cplatform"
Campos de respuesta
La respuesta devuelve un objeto JSON que tiene un array de resultados y un numero de elementos. Cada elemento del array consta de los siguientes campos:
| Nombre | Contenido | Ejemplo | |
|---|---|---|---|
| timestamp | Marca horaria en UTC | 2017-01-11T00:00:00.000Z | |
| event.platform | Plataforma (iOS /Android) | ios | |
| event.country | Geoinformación de la puja en tiempo real | de | |
| event.campaign | ID interna de la campaña de Remerge | 42 | |
| event.campaign_name | Nombre externo de la campaña de Remerge | Test Campaign | |
| event.campaign_type | Tipo de campaña | Instalación/impacto/retargeting | |
| **event.cost_currency | Moneda de la campaña interna de Remerge | EUR | |
| ***event.audience | Identificador de la App Store | 12345678 | |
| event.ad_id | ID de las creaciones | 1406561 | |
| event.ad_name | El nombre de archivo no depurado del activo de imágenes/videos | banner_300_50.png | |
| event.ad_label_id | ID de la etiqueta de las creaciones | 18304 | |
| event.ad_label_name | Nombre de la etiqueta de la creacion | non_purchasers_it | |
| ****event.ad_creative_url | URL de las creaciones | https://assets.remerge.io/ad_assets/files/000/006/696/original/banner_300_50.png?1478088208 | |
| event.impressions | Contador de impresiones diarias en App.Country.Campaign.Ad Level | 2 | |
| event.clicks | Contador de clics diarios en App.Country.Campaign.Ad Level | 1 | |
| event.app_open_rate | Recuento en porcentaje de aplicaciones que se abrieron por clics | 83,57 | |
| event.cost | Costo en la moneda del cliente en App.Country.Campaign.Ad Level | 0,12 | |
| event.conversions | Contador de conversiones diarias en App.Country.Campaign.Ad Level | 1 | |
| event.ap_conversions | Contador de conversiones atribuidas diarias en App.Country.Campaign.Ad Level | 5 | |
| event.unique_user | Contador de usuarios únicos diarios en App.Country.Campaign.Ad Level | 2 |
Respuesta de ejemplo de JSON (dos opciones de visualización de la misma consulta)
Opción 1:
Opción 2:
Si no hay datos para el intervalo dado, la solicitud devuelve un conjunto de resultados vacío y cuenta: 0
Lista de posibles errores
| Estado | Mensaje | Explicación |
|---|---|---|
| 200 | OK | Resultados de la consulta devueltos como JSON |
| 401 | No autorizado | El token de autorización provisto no es válido |
| 422 | start_date: Se requiere el formado AAAA-MM-DD | Formato de la fecha de inicio inadecuado |
| 422 | end_date: Se requiere el formato AAAA-MM-DD | Formato de la fecha de finalización inadecuado |
| 422 | start_date: Debe ser una fecha válida | No se proporcionó una fecha real, como 2015-33-09 |
| 422 | end_date: Debe ser una fecha válida | No se proporcionó una fecha real, como 2015-33-09 |
| 422 | end_date: La fecha de finalización debe ser posterior a la fecha de inicio o igual a esta | La fecha de finalización es anterior a la fecha de inicio. |
| 422 | queryID: Ya existe queryId | El usuario ya ha enviado una solicitud que la API todavía está procesando, es decir, el límite de tasa de consultas por usuario es 1. |
| 504 | Inactividad en el puerto de enlace | El servidor web demoró demasiado tiempo en procesar la solicitud. Por lo general, este error se produce porque se eligió un intervalo de consulta demasiado amplio. En este caso, vuelve a intentarlo con un intervalo más corto de, como máximo, 14 días. |
Índice
* Marca horaria de la API: La start_date y la end_date se establecen por defecto en 00:00 de la medianoche de ese día. Esto significa que, por ejemplo, si deseas consultar un día en particular, debes usar ese día como start_date y el día siguiente como end_date. Asegúrate de solicitar SOLO un día de datos a la vez. Por ejemplo, cada día, solicita los datos de ayer y guárdalos en tu base de datos interna.
** Asegúrate de separar tu informe por campaña después de emplear diferentes monedas para distintas campañas.
*** Remerge usa el término Audiencia en referencia a toda tu aplicación móvil (a diferencia de algunos contextos, en los que una audiencia se refiere a un segmento). Al extraer un informe, la API de informes de Remerge devolverá un campo llamado Audiencia. Esto significa que dicho informe contiene datos estáticos para toda tu aplicación.
**** En el caso de los anuncios dinámicos, la URL de las creaciones que se muestra es solo un marcador de posición, ya que las URL de las creaciones reales se toman de manera dinámica de la fuente. Lamentablemente, no se pueden mostrar en este informe.