API de extracción de Manadge

  • Actualizado el 27 de mayo de 2025
  • Publicado el May 22, 2024
  • 6 minuto(s) de lectura
Anterior Siguiente

La API de extracción de Manadge es una función opcional disponible por un cargo adicional. Para obtener más información, hable con su administrador de Éxito del Cliente de Triton Digital.


La API de extracción de Manadge le permite extraer y exportar datos de un espacio de trabajo de Manadge de forma segura y eficiente. Esta documentación cubre los extremos disponibles, los formatos de respuesta y los métodos de autenticación.

La API de extracción se basa en la función Exportar del espacio de trabajo de Manadge. Los límites siguen siendo los mismos.

Autenticación y acceso a tokens

La API utiliza autenticación basada en token para garantizar un acceso seguro. Los tokens se generan en el espacio de trabajo de la interfaz de usuario de Manadge y se dedican a cada usuario. Estos tokens son el principal medio de autenticación para acceder a la API.

Uso de tokens

Una vez generado, el token debe ser guardado manualmente por usted (el usuario), ya que no será accesible más adelante. Debe incluir su token como autenticación básica con:

  • Dirección de correo electrónico utilizada para iniciar sesión en su espacio de trabajo

  • Token de API generado en su espacio de trabajo

Ciclo de vida del token

  • Vencimiento: Los tokens caducan cada tres meses, por razones de seguridad.

  • Actualización: los tokens se pueden actualizar para extender su validez por otros tres meses. Este proceso se gestiona únicamente dentro del espacio de trabajo de la interfaz de usuario de Manadge y no se puede realizar a través de la API.

  • Revocación: Los tokens se pueden revocar si es necesario. De nuevo, esta acción se administra únicamente dentro del área de trabajo de la interfaz de usuario de Manadge.

Importante: Dado que la administración de tokens (actualización o revocación) se maneja exclusivamente dentro del espacio de trabajo de la interfaz de usuario de Manadge y no a través de la API, debe asegurarse de actualizar o revocar los tokens según sea necesario a través de la página correspondiente.

Puntos de acceso

OBTENER /config

La API proporciona un extremo para recuperar las posibilidades de configuración de un informe. Este extremo le permite obtener información sobre dimensiones, métricas, monedas, tarifas y otros criterios disponibles.

  • Recuperar configuración de extracción de datos

    • Extremo: GET /api/stats/extract/config

    • Descripción: recupera información sobre dimensiones, métricas, monedas, tarifas y otros criterios disponibles para la extracción de datos.

Ejemplo de solicitud:

curl 'https://<workspace>.manadge.tritondigital.com/api/stats/extract/config' 
-u '<your email adress>:<your access token from api key>' 
-H 'Content-Type: application/json'

Ejemplo de respuesta:

 "views": {
        "auction": {
            "groups": [
                "_all"
            ],
            "id": "auction",
            "name": "Auction",
            "dimensions": [
                {
                    "name": "Creative Language",
                    "null_name": "Creative Language Undefined",
                    "id": "creative_language",
                    "type": "dimension",
                    "source": "dimension",
                    "description": "Language of the creative (provided on the bid response)",
                    "can_filter": true
                },
                {
                    "name": "Device Global Region",
                    "null_name": "Device Global Region Undefined",
                    "id": "device_global_region",
                    "type": "dimension",
                    "source": "dimension",
                    "description": "Global territory of bid, retrieved from the IP address",
                    "can_filter": true
                },
                {
                    "name": "App Store URL",
                    "null_name": "App Store URL Undefined",
                    "id": "app_store_url",
                    "type": "dimension",
                    "source": "dimension",
                    "description": null,
                    "can_filter": true
                },
...
    },
  "bid": {
            "groups": [
                "_all"
            ],
            "id": "bid",
            "name": "Bid",
            "dimensions": [
                {
                    "name": "Bid Response Status",
                    "null_name": "Bid Response Status Undefined",
                    "id": "bid_response_status",
                    "type": "dimension",
                    "source": "dimension",
                    "description": null,
                    "can_filter": true
                },
                {
                    "name": "Creative Language",
                    "null_name": "Creative Language Undefined",
                    "id": "creative_language",
                    "type": "dimension",
                    "source": "dimension",
                    "description": "Language of the creative (provided on the bid response)",
                    "can_filter": true
                },
                {
                    "name": "Device Global Region",
                    "null_name": "Device Global Region Undefined",
                    "id": "device_global_region",
                    "type": "dimension",
                    "source": "dimension",
                    "description": "Global territory of bid, retrieved from the IP address",
                    "can_filter": true
                },"
        },
        ...
        }
    }
}

Debe utilizar el botón /config Ruta para recopilar dimensiones y métricas para su consulta. No use las dimensiones y métricas del ejemplo anterior, ya que podrían cambiar a medida que la API evolucione y algunos elementos podrían ser específicos de cuentas individuales.

PUBLICAR /extract

La API proporciona un extremo para generar informes mediante la extracción de archivos ZIP, que incluyen:

  • Metadatos del informe (Fecha, filtros, dimensiones, período, etc.)

  • CSV con los datos.


Este extremo le permite especificar parámetros como fechas, moneda, dimensiones, métricas, orden por, filtros y tipo de vista para generar el informe.

  • Generar informe

    • Punto final: POST /api/stats/extract

    • Método: POST

    • Descripción: genera un informe extrayendo datos en formato Parquet en función de los parámetros especificados.

    • Cuerpo de la solicitud:

      • dates*:Un DateQuery Objeto que representa el intervalo de fechas del informe.

      • dimensions*: Una lista de Dimension objetos que especifican las dimensiones del informe.

        • Debe especificar la id de la dimensión recuperada de la /config consulta.

        • top*: El número de valores máximos por dimensión es manadory (valor máximo 2000).

      • metrics*: una lista de cadenas que representan las métricas que se incluirán en el informe.

        • Debe especificar la id de la dimensión recuperada de la /config consulta.

      • filters*: un diccionario que contiene pares clave-valor para aplicar filtros a los datos del informe. Puede estar vacío si no se aplican filtros.

      • order_by*: una cadena que especifica el campo por el que se ordenarán los datos del informe.

      • view*: una cadena que especifica el tipo de vista para los datos del informe (es decir, subasta u oferta)

      • fee (opcional): una cadena que representa la tarifa asociada con los datos del informe.

      • currency (opcional): una cadena que representa la divisa de los datos del informe.

* Campos obligatorios

Ejemplo de solicitud:

curl --location 'https://{workspace}.manadge.tritondigital.com/api/stats/extract' \
-u '<your email adress>:<your access token from api key>'
--header 'Content-Type: application/json' \
--data '{
    "dates": {"from":"2024-04-29T00:00:00Z","to":"2024-04-30T00:00:00Z"},
    "dimensions":[{"name":"advertiser","top":100}],
    "metrics":["sumImpressions"],
    "order_by":"sumImpressions",
    "filters":{},
    "view":"auction"
}'

Ejemplo del cuerpo de una solicitud:

{
  "dates": {"from":"2024-04-29T00:00:00Z","to":"2024-04-30T00:00:00Z"},
  "currency":"USD",
  "dimensions":[{"name":"advertiser","top":10}],
  "metrics":["sumImpressions"],
  "order_by":"sumImpressions",
  "filters":{},
  "view":"bid"
}

Límites y cuotas

Al usar la API de exportación de datos, debe tener en cuenta los siguientes límites y cuotas:

  • 30 informes por empresa y día: cada empresa puede generar hasta 30 informes por día utilizando la API de exportación de datos.

  • Máximo de 5 dimensiones por informe: cada informe puede incluir un máximo de cinco dimensiones.

  • Métricas ilimitadas por informe: no hay límite para la cantidad de métricas que se pueden incluir en un informe.

  • Actualmente se están estableciendo límites de seguridad y cuotas adicionales.