Nodo de Datos

¿Cómo Funciona?

Para obtener los datos que quieres, solo necesitas enviar una solicitud a nuestro punto de acceso (endpoint). Aquí te dejamos los puntos clave:

Obtén tu API KEY: Dentro de tu cuenta de Dashbo, dirígete a la sección 'Conexiones' en la configuración de tu agencia. Allí encontrarás tu KEY única y secreta. ¡Trátala como una contraseña!
Prepara tu solicitud: Deberás estructurar la solicitud en formato JSON con los datos que quieres consultar. No te preocupes, más abajo te explicamos exactamente cómo hacerlo.
Envía la solicitud: La solicitud debe ser de tipo POST y debe ser enviada a la siguiente URL:
https://data.dashbo.io/getData
Recibe tus datos: Si tu solicitud es correcta, te devolveremos un JSON con toda la información lista para que la uses en tus herramientas de automatización y en tus agentes de IA.

Configuración de la Solicitud

Tu solicitud debe ser un objeto JSON que contenga los siguientes parámetros en el body del POST:

Clave	Tipo	Requerido	Descripción
`apiKey`	Texto	Sí	Tu clave de API secreta que obtuviste desde Dashbo.
`configParams`	Objeto	Sí	Contiene los parámetros de configuración de la consulta.
`dateRange`	Objeto	Sí	El rango de fechas para el cual deseas obtener los datos.
`fields`	Array	Sí	Una lista de las dimensiones y métricas que quieres consultar.
`dimensionsFilters`	Array	No	Una lista de filtros para aplicar a las dimensiones y métricas.

Ejemplo de una solicitud completa:

{
    "apiKey": "tu_api_key_secreta",
    "configParams": {
        "clientId": "123",
        "dataSourceType": "BUSINESS_UNITS"
    },
    "dateRange": {
        "startDate": "2024-01-01",
        "endDate": "2024-01-31"
    },
    "fields": [
        {
            "name": "Campana"
        },
        {
            "name": "Canal"
        },
        {
            "name": "Impresiones"
        },
        {
            "name": "Costo"
        },
        {
            "name": "Clicks",
            "forFilterOnly": true
        }
    ],
    "dimensionsFilters": [
        [
            {
                "fieldName": "Clicks",
                "values": [
                    4000
                ],
                "operator": "NUMERIC_GREATER_THAN"
            }
        ]
    ]
}

Detalles de `configParams`

Este objeto le dice al nodo de datos qué información específica quieres consultar.

Clave	Tipo	Descripción	Valor de Ejemplo
`clientId`	Texto	El ID del cliente del cual quieres obtener datos. Lo puedes encontrar en Dashbo. Cuando vayas a editar un cliente, en la URL verás el ID del cliente.	`"123"`
`dataSourceType`	Texto	La modalidad de datos que deseas. Tienes dos opciones: BUSINESS_UNITS o AD_ACCOUNTS	`"BUSINESS_UNITS"`

Detalles de `fields`

El parámetro fields es un array de objetos, donde cada objeto representa una dimensión o métrica que quieres incluir en la respuesta o usar en los filtros. Cada objeto debe tener una propiedad name con el ID del campo.

Si necesitas filtrar por un campo pero no deseas que aparezca en los resultados, puedes agregar la propiedad "forFilterOnly": true al objeto de ese campo.

Detalles de `dimensionsFilters`

Este parámetro te permite filtrar los datos que se devuelven. Es un array de grupos de filtros. Cada grupo es un array de cláusulas de filtro.

Las cláusulas de filtro dentro de un mismo grupo se combinan con un operador Y (AND).
Los diferentes grupos de filtros se combinan con un operador O (OR).

Cada cláusula de filtro es un objeto con la siguiente estructura:

Clave	Tipo	Descripción
`fieldName`	Texto	El ID del campo por el cual filtrar.
`values`	Array	Un array con los valores para la comparación.
`operator`	Texto	El operador de comparación a utilizar. Ver la tabla de operadores a continuación.

Operadores de Filtro Disponibles

Operador	Descripción
`EQUALS`	El valor de la dimensión coincide exactamente con el valor de comparación.
`CONTAINS`	El valor de la dimensión contiene el valor de comparación.
`REGEXP_PARTIAL_MATCH`	El valor de la dimensión contiene una coincidencia parcial para la expresión regular.
`REGEXP_EXACT_MATCH`	El valor de la dimensión coincide exactamente con la expresión regular.
`IN_LIST`	El valor de la dimensión coincide con alguno de los valores de la lista.
`IS_NULL`	El valor de la dimensión es nulo.
`BETWEEN`	El valor de la dimensión se encuentra entre dos valores (requiere dos valores en el array `values`).
`NUMERIC_GREATER_THAN`	El valor numérico de la dimensión es mayor que el valor de comparación.
`NUMERIC_GREATER_THAN_OR_EQUAL`	El valor numérico de la dimensión es mayor o igual que el valor de comparación.
`NUMERIC_LESS_THAN`	El valor numérico de la dimensión es menor que el valor de comparación.
`NUMERIC_LESS_THAN_OR_EQUAL`	El valor numérico de la dimensión es menor o igual que el valor de comparación.

Modalidades de `dataSourceType`:

BUSINESS_UNITS: Presupuestos (incluye campañas)
- Visualiza la información y métricas de los presupuestos activos del cliente.
- Ideal para reportes que agrupan campañas por objetivos o etapas del embudo (e.g., Upper Funnel, Mid Funnel, Low Funnel).
- Combina datos de distintas plataformas publicitarias y convierte los costos y valores de conversión a la moneda del presupuesto.
AD_ACCOUNTS: Cuentas publicitarias
- Accede a los datos de todas las cuentas publicitarias asociadas a un cliente en una única fuente de datos.
- Perfecto para crear tablas e indicadores con información multicuenta sin la complejidad de los presupuestos.

Formato de la Respuesta

La respuesta que recibirás también será un objeto JSON, diseñado para ser fácil de procesar. Contiene dos claves principales: schema y rows.

schema: Es una lista que describe cada una de las columnas que solicitaste. Te ayuda a entender el orden de los datos.
rows: Es una lista que contiene los registros. Cada registro es un objeto con una clave values, que a su vez contiene una lista con los valores en el mismo orden que se define en el schema.

Ejemplo de una respuesta:

{
    "schema": [
        {
            "name": "Campana",
            "dataType": "STRING"
        },
        {
            "name": "Canal",
            "dataType": "STRING"
        },
        {
            "name": "Impresiones",
            "dataType": "NUMBER"
        },
        {
            "name": "Costo",
            "dataType": "NUMBER"
        }
    ],
    "rows": [
        {
            "values": [
                "Campaña de Verano 2024",
                "FACEBOOK",
                150480,
                512.75
            ]
        },
        {
            "values": [
                "Campaña de Leads Q1",
                "GOOGLE",
                98345,
                450.10
            ]
        }
    ]
}

Datos Disponibles

Aquí tienes la lista completa de dimensiones y métricas que puedes solicitar en el parámetro fields de tu solicitud.

ID	Tipo	Modo Presu-puesto	Modo Cuen- tas	Descripción
Cliente_ID	Dimensión	✔		ID único del cliente en Dashbo.
Cliente	Dimensión	✔		Nombre del cliente en Dashbo.
Presupuesto_ID	Dimensión	✔		ID único del presupuesto en Dashbo.
Presupuesto	Dimensión	✔		Nombre del presupuesto definido en Dashbo.
Presupuesto_Fecha_desde	Dimensión	✔		Fecha de inicio del período del presupuesto.
Presupuesto_Fecha_hasta	Dimensión	✔		Fecha de finalización del período del presupuesto.
Presupuesto_Moneda	Dimensión	✔		Moneda utilizada para el presupuesto en Dashbo.
Presupuesto_Total	Dimensión	✔		Monto total del presupuesto.
Presupuesto_Campana	Dimensión	✔		Monto del presupuesto asignado a nivel de campaña.
Presupuesto_Grupo_de_anuncios	Dimensión	✔		Monto del presupuesto asignado a nivel de grupo de anuncios.
Canal	Dimensión	✔	✔	Plataforma publicitaria (ej: Meta Ads, Google Ads).
Cuenta_ID	Dimensión	✔	✔	ID de la cuenta publicitaria.
Cuenta	Dimensión	✔	✔	Nombre de la cuenta publicitaria.
Huso horario	Dimensión	✔	✔	Zona horaria de la cuenta publicitaria.
Cuenta_Moneda	Dimensión	✔	✔	Moneda de la cuenta publicitaria.
Campana_ID	Dimensión	✔	✔	ID de la campaña.
Campana	Dimensión	✔	✔	Nombre de la campaña.
Grupo_de_Anuncios_ID	Dimensión	✔	✔	ID del grupo de anuncios.
Grupo_de_Anuncios	Dimensión	✔	✔	Nombre del grupo de anuncios.
Anuncio_ID	Dimensión	✔	✔	ID del anuncio en Meta Ads.
Anuncio	Dimensión	✔	✔	Nombre o descripción del anuncio en Meta Ads.
Anuncio_Link_Preview_Compartible	Dimensión	✔	✔	URL para previsualizar el anuncio de Meta Ads.
Anuncio_Link_al_Item_en_Plataforma	Dimensión	✔	✔	URL para ver el anuncio directamente en la plataforma de Meta Ads.
Fecha	Dimensión	✔	✔	Fecha del registro (YYYYMMDD).
Fecha_del_Presupuesto	Dimensión	✔		Devuelve 'Verdadero' si la fecha de la fila se encuentra dentro del período del presupuesto activo en Dashbo; de lo contrario, 'Falso'
Impresiones	Métrica	✔	✔	Número de veces que se mostraron los anuncios.
Valor_de_compra	Métrica	✔	✔	Sólo en la modalidad 'Presupuestos (con campañas)', este valor es convertido a la Moneda del Presupuesto si difiere de la Moneda de la Cuenta.
Clicks	Métrica	✔	✔	Número total de clics en los anuncios.
Costo	Métrica	✔	✔	Sólo en la modalidad 'Presupuestos (con campañas)', este valor es convertido a la Moneda del Presupuesto si difiere de la Moneda de la Cuenta.
Conversiones_Primarias	Métrica		✔	Eventos de conversión principales definidos en la plataforma publicitaria.
Eventos_Seleccionados	Métrica	✔		Contabiliza los eventos configurados como conversión principal en el Presupuesto dentro de Dashbo
CTR	Métrica	✔	✔	Tasa de clics (Clicks / Impresiones)
ROAS	Métrica	✔	✔	Retorno de la inversión publicitaria (Valor de compra / Costo)
CPA_Eventos_seleccionados	Métrica	✔		Costo por adquisición (Costo / Conversiones del Presupuesto). Sólo en la modalidad 'Presupuestos (con campañas)', este valor es convertido a la Moneda del Presupuesto si difiere de la Moneda de la Cuenta.
CPA_Conversiones_primarias	Métrica		✔	Costo por adquisición (Costo / Conversiones primarias)
Conv_Rate_Conversiones_primarias	Métrica		✔	Tasa de conversión (Conversiones primarias / Clics * 100)
ACOS	Métrica	✔	✔	Costo publicitario de venta (Costo / Valor de compra)
CPC	Métrica	✔	✔	Costo por clic (Costo / Clics)
CPM	Métrica	✔	✔	Costo por mil impresiones (Costo / Impresiones * 1000). Sólo en la modalidad 'Presupuestos (con campañas)', este valor es convertido a la Moneda del Presupuesto si difiere de la Moneda de la Cuenta.
HOOK_RATE	Métrica	✔	✔	Visualizaciones de Video (3 segundos) / Impresiones.
Meta_Edad	Dimensión	✔	✔	Rango de edad del público alcanzado en Meta Ads.
Meta_Genero	Dimensión	✔	✔	Género del público alcanzado en Meta Ads.
Meta_Plataforma_Publicacion	Dimensión	✔	✔	Dónde se mostró el anuncio en Meta (ej: Facebook, Instagram).
Meta_Posicion_Plataforma	Dimensión	✔	✔	Ubicación específica del anuncio (ej: Feed, Stories).
Meta_Dispositivo	Dimensión	✔	✔	Dispositivo desde el que se vio el anuncio.
Meta_Region	Dimensión	✔	✔	Región geográfica del público.
Meta_Pais	Dimensión	✔	✔	País del público.
Meta_Alcance	Métrica	✔	✔	Número de personas únicas que vieron tus anuncios.
Meta_Frecuencia	Métrica	✔	✔	Promedio de veces que cada persona vio tu anuncio.
Meta_Pixel_purchase	Métrica		✔	Número de eventos de compra registrados por el Píxel de Meta.
Meta_Messaging_conversation_started_7d	Métrica		✔	Conversaciones iniciadas en los últimos 7 días.
Meta_Comment	Métrica		✔	Número de comentarios en los anuncios.
Meta_Lead	Métrica		✔	Número de leads generados.
Meta_Like	Métrica		✔	Número de "Me gusta" en los anuncios.
Meta_Link_click	Métrica		✔	Clics en el enlace del anuncio.
Meta_Post_engagement	Métrica		✔	Total de interacciones con la publicación.
Meta_Post_reaction	Métrica		✔	Total de reacciones a la publicación.
Meta_Video_view	Métrica		✔	Vistas de video de al menos 3 segundos.
Meta_Pixel_add_to_cart	Métrica		✔	Eventos de "Añadir al carrito" registrados por el Píxel de Meta.
Meta_Pixel_initiate_checkout	Métrica		✔	Eventos de "Iniciar pago" registrados por el Píxel de Meta.
Meta_Pixel_complete_registration	Métrica		✔	Eventos de "Registro completado" registrados por el Píxel de Meta.
Meta_Todos_los_tipos_de_leads	Métrica		✔	Suma de Leads, Conversaciones 7d y Registros completados.
Meta_CPA_Todos_los_tipos_de_leads	Métrica		✔	Costo por adquisición de todos los tipos de leads.
Meta_Costo_por_compra	Métrica	✔	✔	Costo por cada compra registrada por el Píxel de Meta.
Meta_Costo_por_agregar_al_carrito	Métrica	✔	✔	Costo por cada vez que un usuario agrega un producto al carrito.
Meta_Costo_por_checkout_iniciado	Métrica	✔	✔	CPA considerando los siguientes eventos: Meta Ads - Iniciar checkout (pixel)
GA4__Conversiones	Métrica	✔	✔	Total de conversiones registradas en Google Analytics 4.
GA4__Transacciones_de_comercio_electrónico	Métrica	✔	✔	Total de transacciones de e-commerce.
GA4__Ingresos_por_compras	Métrica	✔	✔	Sólo en la modalidad 'Presupuestos (con campañas)', este valor es convertido a la Moneda del Presupuesto si difiere de la Moneda de la Cuenta.
GA4__Sesiones	Métrica	✔	✔	Total de sesiones iniciadas.
GA4__Usuario_activos	Métrica	✔	✔	Número de usuarios activos.